检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
状态码 正常状态码 描述 200 OK 201 Created 202 Accepted 204 No Content 错误状态码 描述 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method
勾选“同意《公测试用服务协议》”,单击“申请公测”。 公测申请提交后,5个工作日内审核结果将发送到您的邮箱和手机。
勾选“同意《公测试用服务协议》”,单击“申请公测”。 公测申请提交后,5个工作日内审核结果将发送到您的邮箱和手机。
步骤二:获取访问密钥(AK/SK) 操作场景 通过控制台访问KVS,您首先要使用您的华为云账号或IAM用户登录控制台,在这种场景下KVS通过您的账号或IAM用户信息进行鉴权。 而在使用其他方式访问KVS时,例如工具SDK或API,不需要您提供华为云账号或IAM用户登录信息,取而代之的是通过账号或
查询表 功能介绍 指定仓查询表属性,如容量,规模,配额。 URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
列举表 功能介绍 指定仓列举创建的所有表。 URI POST /v1/list-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
创建表 功能介绍 在指定仓内创建表,表名在仓内唯一;创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。创建表时,如果仓不存在,将会自动创建仓。 URI POST /v1/create-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name
查询单个kv 功能介绍 下载一个kv文档的全部内容,或者部分字段的内容。 URI POST /v1/get-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
列举仓 功能介绍 一个账户下可以创建最多25个仓,每个仓可以创建最多100个store,响应中一次性返回所有仓名称。 URI POST /v1/list-store 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 cursor_name 否 String 上次返回的游标位置
扫描所有kv 功能介绍 指定表,扫描表下所有kv;允许指定过滤条件。 URI POST /v1/scan-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
扫描分区键内kv 功能介绍 指定表及分区键,携带条件查询kv;允许指定过滤条件。 URI POST /v1/scan-skey-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix
删除单个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 仓名,全域唯一,不同租户的仓名不能相同
批量写请求 功能介绍 批量写请求,其中可以携带一或多个表的不同kv的写操作,上传kv/删除kv。 URI POST /v1/batch-write-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同
更新单个kv 功能介绍 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个3xx,4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题
身份认证与访问控制 IAM身份认证 用户访问KVS的方式有多种,包括KVS控制台、API、SDK,无论访问方式封装成何种形式,其本质都是通过KVS提供的REST风格的API接口进行请求。 KVS的接口支持认证请求。经过认证的请求总是需要包含一个签名值,该签名值以请求者的访问密钥(AK
支持的监控指标 功能说明 本节定义了KVS上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索KVS产生的监控指标和告警信息。 命名空间 SYS.KVS 监控指标 表1 KVS支持的监控指标 指标ID 指标名称 指标含义
附录 状态码 错误码 获取项目ID 获取账号ID