检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 C++ huaweicloud-sdk-cpp-v3
如果用户已注册,可直接登录管理控制台,从主页选择“键值存储服务 KVS”。如果未注册,请参见注册华为云并实名认证。 SDK方式 KVS提供Java、C++等主流语言,帮助用户使用SDK完成二次开发,使用SDK方式访问键值存储服务,具体操作请参见《键值存储服务SDK参考》。
使用API、SDK方式访问KVS时需要提前获取终端节点(Endpoint),具体操作请参见步骤三:获取终端节点。 使用SDK前,需要先下载对应工具或SDK源码,并进行初始化配置,具体操作请参见步骤四:下载SDK并初始化。 存储仓是用来存储表数据的单元,在创建表前需要先创建存储仓,具体操作请参见步骤五:创建存储仓。
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个3xx,4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题。
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
构造请求 本节介绍REST API请求的组成,并以调用KVS服务的创建表来说明如何调用API,该API可以创建表。 请求URI 请求URI由如下部分组成(方括号部分可选): {URI-scheme}://[{store-name}.]{Endpoint}/{resource-path}[
步骤六:创建表(同时指定索引) 操作场景 表是用来存储键值数据的集合,在插入KV数据前需要先创建表。KVS提供多种使用方式,您可以根据使用习惯、业务场景选择不同的方式来创建表。 操作步骤 表1 不同访问方式创建表的方法 访问方式 创建表方法 控制台 通过控制台创建表 SDK 通过SDK创建表
步骤五:创建存储仓 操作场景 存储仓是用来存储表数据的单元,在创建表前需要先创建存储仓。KVS提供多种使用方式,您可以根据使用习惯、业务场景选择不同的方式来创建存储仓。 操作步骤 表1 不同访问方式创建存储仓的方法 访问方式 创建存储仓方法 控制台 通过控制台创建存储仓 SDK 通过SDK创建存储仓
列举表 功能介绍 指定仓列举创建的所有表。 URI POST /v1/list-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code
查询单个kv 功能介绍 下载一个kv文档的全部内容,或者部分字段的内容。 URI POST /v1/get-kv 表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或覆盖已有kv,且满足表的key schema描述;允许指定条件执行。 URI POST /v1/put-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。
查询表 功能介绍 指定仓查询表属性,如容量,规模,配额。 URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${
更新单个kv 功能介绍 指定表,指定主键,指定更新文档的部分内容,如果是自描述文档,指定字段名;如果是二进制文档,指定偏移位置和长度;允许指定条件执行。 URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String
步骤三:获取终端节点 概述 华为云租户通过API、SDK方式访问KVS服务时,需要通过VPC终端节点对接KVS。本章节指导用户如何通过VPC终端节点(下文简称:VPCEP)对接KVS。 用户购买VPC终端节点,创建内网域名,内网域名即用户使用API、SDK访问KVS过程中使用到的终端节点。
VPC终端节点对接KVS 概述 华为云租户通过API、SDK方式访问KVS服务时,需要通过VPC终端节点对接KVS。本章节指导用户如何通过VPC终端节点(下文简称:VPCEP)对接KVS。 VPCEP对接KVS主要分为以下三大步骤: 购买连接“接口”型终端节点服务的终端节点。 创建内网域名。
扫描分区键内kv 功能介绍 指定表及分区键,携带条件查询kv;允许指定过滤条件。 URI POST /v1/scan-skey-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${
扫描所有kv 功能介绍 指定表,扫描表下所有kv;允许指定过滤条件。 URI POST /v1/scan-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${r
创建表 功能介绍 在指定仓内创建表,表名在仓内唯一;创建表时,指定主键模板及本地二级索引模板及全局二级索引模板。创建表时,如果仓不存在,将会自动创建仓。 URI POST /v1/create-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name