检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
换行符分隔。 权重 可选参数。 返回解析记录的权重比例。默认值为1,取值范围:0~1000。 标签 可选参数。 记录集的标识,包括键和值,每个记录集可以创建10个标签。 描述 可选参数。 对域名的描述。长度不超过255个字符。 单击“确定”,返回“解析记录”页面。添加完成后,您可
如何调用API 构造请求 认证鉴权 返回结果
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个3xx,4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题。
Long 返回的文档个数,最大100个。 说明: 默认100个文档。 shard_key 是 Document 要遍历的指定分区键下的kv。 start_sort_key 否 Document 起始排序键值,默认空表示从头遍历,左闭。 说明: 分页返回时,该值使用上次响应返回的cursor_sort_key
API概览 表1 接口说明 类型 子类型 说明 仓接口 列举仓 一个账户下可以创建最多25个仓,每个仓可以创建最多100个store,响应中一次性返回所有仓名称。 创建表 在指定存储仓内创建表,表名在存储仓内唯一; 创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。 列举表 指定存储仓列举创建的所有表。
内容字段:主键字段+投影字段或者全部字段。 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例 下载一个kv,表名为test-table-1,设置分区键值为user1,排序键值为test-file-1。
counts 仓 1分钟 store_kv_request_latency_ave 请求平均时延 该指标用于统计周期内从系统收到完整请求到结束返回响应的耗时平均值。 单位:毫秒 ≥ 0 ms 仓 1分钟 store_read_traffic 读流量 该指标用于统计当前统计周期内读取类请求文档大小总和。
该部分可选。请求消息体通常以Bson格式发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),列举仓接口就不需要消息体,消息体具体内容需要根据具体接口而定。
插入元素到数组中 说明: 非数组返回失败。 delete 否 Document 从数组中删除某个元素 说明: 值不存在则返回失败。 响应参数 状态码:400 表9 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String
响应参数 状态码:400 表8 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例 上传单个kv,表名为test-table-1。 POST https://{endpoint}/v1/put-kv
"deleting" 状态码:400 表13 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例 查询表名为test-table的表信息 POST https://{endpoint}/v1/describe-table
error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 状态码:409 表17 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例
响应参数 状态码:400 表8 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例 删除单个kv,删除kv的分区键为user,排序键为test-file-1 POST ht
strings 返回的表名列表。 长度:最大100 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例 列举指定仓中的表,限制返回表数量为2 POST
"oper_id"数组。 数组元素:请求内的操作编码,未成功的操作返回该标识。 delete_kv_ids Array of integers 请求内的操作编码,未成功的操作返回该标识。 数组元素:请求内的操作编码,未成功的操作返回该标识。 请求示例 批量写请求,向test-table-1表中插入和删除一个kv
换行符分隔。 权重 可选参数。 返回解析记录的权重比例。默认值为1,取值范围:0~1000。 标签 可选参数。 记录集的标识,包括键和值,每个记录集可以创建10个标签。 描述 可选参数。 对域名的描述。长度不超过255个字符。 单击“确定”,返回“解析记录”页面。添加完成后,您可
strings 返回的仓名列表。 状态码:400 表3 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。 请求示例 列举用户账户下的仓,从指定仓名位置开始返回,限制返回仓名数量2个。
取值字符限制:[a-z0-9_-]+ limit 否 Integer 返回的文档个数,最大100个。 说明: 默认100个文档。 start_key 否 Document 起始主键或索引键值。 默认空,表示从头遍历,左闭。 说明: 分页返回时,该值使用上次响应返回的cursor_key。 end_key 否