检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 接口说明 类型 子类型 说明 仓接口 列举仓 一个账户下可以创建最多25个仓,每个仓可以创建最多100个store,响应中一次性返回所有仓名称。 创建表 在指定存储仓内创建表,表名在存储仓内唯一; 创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。 列举表
如何调用API 构造请求 认证鉴权 返回结果
响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于创建表接口,返回如图1所示的消息头。表创建好后,可以开始调用其他API接口执行向表中插入KV数据、查询KV数据等其他操作。 图1 创建表响应消息头 响应消息体(可选) 该部分可选。
请求消息体通常以Bson格式发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。
API 仓接口 表接口 KV接口
AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
仓接口 列举仓 创建表 列举表 父主题: API
KV接口 上传单个kv 查询单个kv 更新单个kv 删除单个kv 扫描所有kv 扫描分区键内kv 批量写请求 父主题: API
表接口 查询表 父主题: API
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
批量写请求 功能介绍 批量写请求,其中可以携带一或多个表的不同kv的写操作,上传kv/删除kv。 URI POST /v1/batch-write-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
查询表 功能介绍 指定仓查询表属性,如容量,规模,配额。 URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
更新单个kv 功能介绍 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String
列举仓 功能介绍 一个账户下可以创建最多25个仓,每个仓可以创建最多100个store,响应中一次性返回所有仓名称。 URI POST /v1/list-store 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 cursor_name 否 String 上次返回的游标位置
删除单个kv 功能介绍 指定表,指定主键,删除该文档;允许指定条件执行。 URI POST /v1/delete-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-
列举表 功能介绍 指定仓列举创建的所有表。 URI POST /v1/list-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}
创建表 功能介绍 在指定仓内创建表,表名在仓内唯一;创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。创建表时,如果仓不存在,将会自动创建仓。 URI POST /v1/create-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name
查询单个kv 功能介绍 下载一个kv文档的全部内容,或者部分字段的内容。 URI POST /v1/get-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
扫描所有kv 功能介绍 指定表,扫描表下所有kv;允许指定过滤条件。 URI POST /v1/scan-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code