检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
附录 状态码 错误码 获取项目ID 获取账号ID
仓接口 列举仓 创建表 列举表 父主题: API
产品优势 Serverless云存储 无需购买计算资源且无需预置资源,完全托管,简单易用,为您节省运维成本,拥有云账号即可实现键值的存取。 存储结构灵活 支持BSON格式数据类型,原生数据格式无需字符串转换,数据处理更高效,且支持多数据类型字段自由组合。 数据读写效率高 支持本地二级索引和全局二级索引,提升检索效率;
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
应用场景 广告场景 使用KVS存储各种营销数据,如:用户资料、用户事件、点击和访问的链接等。使用这些数据可以进行实时出价、广告定位等。 游戏场景 使用KVS存储游戏状态、玩家数据、会话历史记录和排行榜等数据。 媒体和娱乐 使用KVS存储媒体元数据、用户数据、数字权限管理等信息。 软件和互联网
查询单个kv 功能介绍 下载一个kv文档的全部内容,或者部分字段的内容。 URI POST /v1/get-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${
列举表 功能介绍 指定仓列举创建的所有表。 URI POST /v1/list-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
构造请求 本节介绍REST API请求的组成,并以调用KVS服务的创建表来说明如何调用API,该API可以创建表。 请求URI 请求URI由如下部分组成(方括号部分可选): {URI-scheme}://[{store-name}.]{Endpoint}/{resource-path}[
批量写请求 功能介绍 批量写请求,其中可以携带一或多个表的不同kv的写操作,上传kv/删除kv。 URI POST /v1/batch-write-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。
删除单个kv 功能介绍 指定表,指定主键,删除该文档;允许指定条件执行。 URI POST /v1/delete-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}
上传单个kv 功能介绍 指定表,新建kv或覆盖已有kv,且满足表的key schema描述;允许指定条件执行。 URI POST /v1/put-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。
查询表 功能介绍 指定仓查询表属性,如容量,规模,配额。 URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${
更新单个kv 功能介绍 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String
扫描分区键内kv 功能介绍 指定表及分区键,携带条件查询kv;允许指定过滤条件。 URI POST /v1/scan-skey-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${
扫描所有kv 功能介绍 指定表,扫描表下所有kv;允许指定过滤条件。 URI POST /v1/scan-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${r
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个3xx,4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题。
VPC终端节点对接KVS 概述 华为云租户通过API、SDK方式访问KVS服务时,需要通过VPC终端节点对接KVS。本章节指导用户如何通过VPC终端节点(下文简称:VPCEP)对接KVS。 VPCEP对接KVS主要分为以下三大步骤: 购买连接“接口”型终端节点服务的终端节点。 创建内网域名。
步骤三:获取终端节点 概述 华为云租户通过API、SDK方式访问KVS服务时,需要通过VPC终端节点对接KVS。本章节指导用户如何通过VPC终端节点(下文简称:VPCEP)对接KVS。 用户购买VPC终端节点,创建内网域名,内网域名即用户使用API、SDK访问KVS过程中使用到的终端节点。
创建表 功能介绍 在指定仓内创建表,表名在仓内唯一;创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。创建表时,如果仓不存在,将会自动创建仓。 URI POST /v1/create-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name