检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
仓接口 列举仓 创建表 列举表 父主题: API
表接口 查询表 父主题: API
KV接口 上传单个kv 查询单个kv 更新单个kv 删除单个kv 扫描所有kv 扫描分区键内kv 批量写请求 父主题: API
通过控制台访问KVS,您首先要使用您的华为云账号或IAM用户登录控制台,在这种场景下KVS通过您的账号或IAM用户信息进行鉴权。 而在使用其他方式访问KVS时,例如工具SDK或API,不需要您提供华为云账号或IAM用户登录信息,取而代之的是通过账号或IAM用户的访问密钥(AK/SK)来进行鉴权。所以您在使
步骤四:下载SDK并初始化 操作场景 在使用SDK访问KVS前,您需要提前获取和安装KVS SDK,并进行相关的配置和初始化。 操作步骤 表1 工具获取和初始化 工具 获取和安装方法 配置和初始化方法 SDK 参见SDK概述>参考文档的“SDK获取和安装”章节。 参见SDK概述>参考文档的“用户手册”。
创建表 功能介绍 在指定仓内创建表,表名在仓内唯一;创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。创建表时,如果仓不存在,将会自动创建仓。 URI POST /v1/create-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name
查询表 功能介绍 指定仓查询表属性,如容量,规模,配额。 URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${
批量写请求 功能介绍 批量写请求,其中可以携带一或多个表的不同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;允许指定过滤条件。 URI POST /v1/scan-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${r
列举表 功能介绍 指定仓列举创建的所有表。 URI POST /v1/list-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
更新单个kv 功能介绍 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String
查询单个kv 功能介绍 下载一个kv文档的全部内容,或者部分字段的内容。 URI POST /v1/get-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${
列举仓 功能介绍 一个账户下可以创建最多25个仓,每个仓可以创建最多100个store,响应中一次性返回所有仓名称。 URI POST /v1/list-store 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 cursor_name 否 String 上次返回的游标位置,本次响应包含该仓名。
上传单个kv 功能介绍 指定表,新建kv或覆盖已有kv,且满足表的key schema描述;允许指定条件执行。 URI POST /v1/put-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。
扫描分区键内kv 功能介绍 指定表及分区键,携带条件查询kv;允许指定过滤条件。 URI POST /v1/scan-skey-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${
使用API、SDK方式访问KVS时需要提前获取终端节点(Endpoint),具体操作请参见步骤三:获取终端节点。 使用SDK前,需要先下载对应工具或SDK源码,并进行初始化配置,具体操作请参见步骤四:下载SDK并初始化。 存储仓是用来存储表数据的单元,在创建表前需要先创建存储仓,具体操作请参见步骤五:创建存储仓。
身份认证与访问控制 IAM身份认证 用户访问KVS的方式有多种,包括KVS控制台、API、SDK,无论访问方式封装成何种形式,其本质都是通过KVS提供的REST风格的API接口进行请求。 KVS的接口支持认证请求。经过认证的请求总是需要包含一个签名值,该签名值以请求者的访问密钥(
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个3xx,4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题。
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头