检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
更新单个kv 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 删除单个kv 指定表,指定主键,删除该文档;允许指定条件执行。 扫描所有kv 指定表,扫描表下所有kv;允许指定过滤条件。 扫描分区键内kv 指
表接口 查询表 父主题: API
仓接口 列举仓 创建表 列举表 父主题: API
KV接口 上传单个kv 查询单个kv 更新单个kv 删除单个kv 扫描所有kv 扫描分区键内kv 批量写请求 父主题: API
如何调用API 构造请求 认证鉴权 返回结果
API 仓接口 表接口 KV接口
/v1/batch-write-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}-${account-id},其中prefix为自定义前缀,region-code为kv
/v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}-${account-id},其中prefix为自定义前缀,region-code为kv
查询单个kv 功能介绍 下载一个kv文档的全部内容,或者部分字段的内容。 URI POST /v1/get-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${reg
更新单个kv 功能介绍 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String
/v1/put-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}-${account-id},其中prefix为自定义前缀,region-code为kv
/v1/create-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}-${account-id},其中prefix为自定义前缀,region-code为kv
/v1/list-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}-${account-id},其中prefix为自定义前缀,region-code为kv
功能介绍 指定表,指定主键,删除该文档;允许指定条件执行。 URI POST /v1/delete-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${regi
resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“创建表”API接口的resource-path为“/v1/create-table”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“
空表示主索引。 长度:[3, 63] 取值字符限制:[a-z0-9_-]+ limit 否 Integer 返回的文档个数,最大100个。 说明: 默认100个文档。 start_key 否 Document 起始主键或索引键值。 默认空,表示从头遍历,左闭。 说明: 分页返回时
列表请参见状态码。 对于创建表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于创建表接口,返回如图1所示的消息头。表创建好后,可以开始调用其他API接口执行向表中插入KV数据、查询KV数据等其他操作。
"test-store-name-2" ] } 状态码 状态码 描述 200 表示列举仓成功。 400 BadRequest 错误码 请参见错误码。 父主题: 仓接口
hint_index_name 否 String create_table时指定的索引名。 limit 否 Long 返回的文档个数,最大100个。 说明: 默认100个文档。 shard_key 是 Document 要遍历的指定分区键下的kv。 start_sort_key 否 Document
附录 状态码 错误码 获取项目ID 获取账号ID