键值存储服务 KVS-华为云

键值存储服务 KVS-批量写请求:请求示例

请求示例批量写请求，向test-table-1表中插入和删除一个kv POST https://{endpoint}/v1/batch-write-kv { "table_opers" : [ { "table_batch" : { "table_name" : "test_table_1", "kv_opers" : [ { "put_kv" : { "oper_id" : 1, "kv_doc" : { "owner" : "user_3", "filename" : "test_file_3" } } }, { "delete_kv" : { "oper_id" : 2, "primary_key" : { "owner" : "user_2", "filename" : "test_file_2" } } } ] } } ] }

键值存储服务 KVS

键值存储服务 KVS-批量写请求:响应参数

响应参数状态码： 200 表7 响应Body参数参数参数类型描述 unprocessed_opers Array of table_oper_ids objects 未处理的操作列表。表8 table_oper_ids 参数参数类型描述 table_name String 表名，仓内唯一。长度：[3, 63] 取值字符限制：[a-z0-9_-]+ kv_oper_ids kv_oper_ids object kv操作数组。表9 kv_oper_ids 参数参数类型描述 put_kv_ids Array of integers 上传kv操作, "oper_id"数组。数组元素：请求内的操作编码，未成功的操作返回该标识。 delete_kv_ids Array of integers 请求内的操作编码，未成功的操作返回该标识。数组元素：请求内的操作编码，未成功的操作返回该标识。

键值存储服务 KVS

键值存储服务 KVS-批量写请求:请求参数

请求参数表2 请求Body参数参数是否必选参数类型描述 table_opers 是 Array of table_batch objects 行操作数组，可以是多个表的操作。表3 table_batch 参数是否必选参数类型描述 table_name 是 String 表名，仓内唯一。长度：[3, 63] 取值字符限制：[a-z0-9_-]+ kv_opers 是 Array of oper_item objects kv操作数组。表4 oper_item 参数是否必选参数类型描述 put_kv 否 put_kv object 上传kv操作。 delete_kv 否 delete_kv object 删除kv操作。表5 put_kv 参数是否必选参数类型描述 oper_id 是 Integer 请求内的操作编码，未成功的操作返回该标识。 kv_doc 否 Document 用户文档。表6 delete_kv 参数是否必选参数类型描述 oper_id 是 Integer 请求内的操作编码，未成功的操作返回该标识。 primary_key 是 Document 用户自定义的主键名及值。

键值存储服务 KVS

键值存储服务 KVS-批量写请求:URI

URI POST /v1/batch-write-kv 表1 Query参数参数是否必选参数类型描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部

键值存储服务 KVS

键值存储服务 KVS-删除单个kv:请求参数

请求参数表2 请求Body参数参数是否必选参数类型描述 table_name 是 String 表名，仓内唯一。长度：[3, 63] 取值字符限制：[a-z0-9_-]+ primary_key 是 Document 用户自定义的主键名及值。说明：内容字段为主键字段名和值，组合索引多个元素。 condition_expression 否 condition_expression object 条件表达式，参见conditional小节。说明：禁止携带主键字段, 参见conditional小节的定义。表3 condition_expression 参数是否必选参数类型描述 single_field_expression 否 single_field_expression object 单字段条件。表4 single_field_expression 参数是否必选参数类型描述 field 是 String 条件字段。 func 是 String 条件函数，取值如"$gt", $lt","$gte", $lte" "$eq", "$ne", "$prefix", "$exists"。 value 否 Document value和value_array二选一。 value条件值，适用于除"$in", "$nin"外的func。字段名无意义，可以传空，也可以传字段名。 $exists值为true/false。说明： $prefix操作只适用于string和binary类型。 value_array 否 Array of strings "value"和"value_array"二选一。 "value_array" 条件值列表, 值用于"$in", "$nin"。

键值存储服务 KVS

键值存储服务 KVS-删除单个kv:URI

URI POST /v1/delete-kv 表1 Query参数参数是否必选参数类型描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部

键值存储服务 KVS

键值存储服务 KVS-列举表:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 cursor_name String 本次响应后的游标位置，下次请求时携带，如果为空，表示后面无更多。长度：[3, 63] 取值字符限制：[a-z0-9_-]+ 说明：如果为空，表示后面无更多。 table_names Array of strings 返回的表名列表。长度：最大100 状态码： 400 表4 响应Body参数参数参数类型描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。

键值存储服务 KVS

键值存储服务 KVS-列举表:URI

URI POST /v1/list-table 表1 Query参数参数是否必选参数类型描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部

键值存储服务 KVS

键值存储服务 KVS-认证鉴权:AK/SK认证

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

键值存储服务 KVS

键值存储服务 KVS-查询单个kv:URI

URI POST /v1/get-kv 表1 Query参数参数是否必选参数类型描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部

键值存储服务 KVS

键值存储服务 KVS-查询单个kv:请求示例

请求示例下载一个kv，表名为test-table-1，设置分区键值为user1，排序键值为test-file-1。 POST https://{endpoint}/v1/get-kv { "table_name" : "test_table_1", "primary_key" : { "owner" : "user_1", "filename" : "test_file_1" } }

键值存储服务 KVS

键值存储服务 KVS-上传单个kv:请求参数

请求参数表2 请求Body参数参数是否必选参数类型描述 table_name 是 String 表名，仓内唯一。长度：[3, 63] 取值字符限制：[a-z0-9_-]+ condition_expression 否 condition_expression object 条件表达式，参见conditional小节。长度：[8,4096] kv_doc 否 Document 用户文档。表3 condition_expression 参数是否必选参数类型描述 single_field_expression 否 single_field_expression object 单字段条件。表4 single_field_expression 参数是否必选参数类型描述 field 是 String 条件字段。 func 是 String 条件函数，取值如"$gt", $lt","$gte", $lte" "$eq", "$ne", "$prefix", "$exists"。 value 否 Document value和value_array二选一。 value条件值，适用于除"$in", "$nin"外的func。字段名无意义，可以传空，也可以传字段名。 $exists值为true/false。说明： $prefix操作只适用于string和binary类型。 value_array 否 Array of strings "value"和"value_array"二选一。 "value_array" 条件值列表, 值用于"$in", "$nin"。

键值存储服务 KVS

键值存储服务 KVS-上传单个kv:请求示例

请求示例上传单个kv，表名为test-table-1，上传的kv为非结构化数据 POST https://{endpoint}/v1/put-kv { "table_name" : "test_table_1", "kv_doc" : { "owner" : "user_1", "filename" : "test_file_1", "otherKey" : "other" } }

键值存储服务 KVS

键值存储服务 KVS-上传单个kv:URI

URI POST /v1/put-kv 表1 Query参数参数是否必选参数类型描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部

键值存储服务 KVS

键值存储服务 KVS-扫描所有kv:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 returned_count Integer 返回的文档数量，为0不表示结束。说明：如果filtered_count超过500仍无匹配，则返回0。 filtered_count Integer 被过滤掉的文档数量。 cursor_key Document 下次请求时的start_key，该值为空时，表示指定范围或者指定filter条件所有kv已经返回。 returned_kv_items Array of returned_kv_item objects 返回的kv数据。表6 returned_kv_item 参数参数类型描述 kv_doc Document 对kv_doc有效。

键值存储服务 KVS

云服务器内容精选

键值存储服务 KVS

7*24

备案

专业服务

退订

建议反馈

售前咨询热线