键值存储服务 KVS-华为云

键值存储服务 KVS-创建表:操作步骤

操作步骤登录KVS管理控制台。在KVS管理控制台左侧导航栏选择“仓”，进入存储仓列表。在仓列表中找到需要创建表的仓，在仓对应的操作列，单击“创建表”，或者单击仓名称进入仓的详情页面，在“表信息”下单击“创建表”。根据界面提示，配置“表详细信息”参数。图1 “表详细信息”界面表1 “表详细信息”参数说明类别参数名称描述表详细信息表名称必选参数。表的名称。表的名称长度范围为3-52个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成，且表的名称在存储仓内唯一。分区键必选参数。分区键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。排序键可选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。根据界面提示，配置“二级索引”。支持创建本地二级索引和全局二级索引。单击“创建本地二级索引”，配置参数信息如表2所示。确认配置信息后单击“确定”。图2 “创建本地二级索引”界面表2 “创建本地二级索引”参数说明类别参数名称描述创建本地二级索引名称必选参数。本地二级索引的名称。名称的长度范围为1-255个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”、“.”组成。名称不支持设置为“XPriIndex”。排序键必选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。摘要可选参数。本地二级索引的摘要字段。支持创建多个摘要。摘要的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。单击“创建全局二级索引”，配置参数信息如表3所示。确认配置信息后单击“确定”。图3 “创建全局二级索引”界面表3 “创建全局二级索引”参数说明类别参数名称描述创建全局二级索引名称必选参数。全局二级索引的名称。名称的长度范围为1-255个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”、“.”组成。名称不支持设置为“XPriIndex”。分区键必选参数。分区键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。排序键可选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。摘要可选参数。全局二级索引的摘要字段。支持创建多个摘要。摘要的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。信息设置完成后，单击“确定”。

键值存储服务 KVS

键值存储服务 KVS-存储仓简介

存储仓简介存储仓，简称仓，是KVS中存储和检索任意规模数据的单位。用户可以根据自己的业务系统划分，创建不同的仓。 KVS自顶向下按照仓、表、KV的结构存储数据，仓中包含至少1个或多个表，表中包含至少1个或多个KV。例如，用一张表记录某个部门所有员工的信息，每一个仓就代表一个部门。图1 存储仓简介 KVS云服务支持创建存储仓，查询存储仓及详细信息。表1 KVS云服务管理控制台支持的存储仓相关功能功能描述创建存储仓在KVS管理控制台创建存储仓，同时创建一个表并指定索引。查询存储仓列表在KVS管理控制台查看存储仓列表。查询存储仓详细信息查看存储仓的详情。父主题：存储仓管理

键值存储服务 KVS 存储仓管理

键值存储服务 KVS-创建索引:操作步骤

操作步骤登录KVS管理控制台。在KVS管理控制台左侧导航栏选择“仓”，进入存储仓列表。在仓列表中找到需要创建索引的表所在的仓，在仓对应的操作列，单击“创建表”，或者单击仓名称进入仓的详情页面，在“表信息”下单击“创建表”。根据界面提示，填写表详细信息。根据界面提示，配置“二级索引”。支持创建本地二级索引和全局二级索引。单击“创建本地二级索引”，配置参数信息如表1所示。确认配置信息后单击“确定”。图1 “创建本地二级索引”界面表1 “创建本地二级索引”参数说明类别参数名称描述创建本地二级索引名称必选参数。本地二级索引的名称。名称的长度范围为1-255个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”、“.”组成。名称不支持设置为“XPriIndex”。排序键必选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。摘要可选参数。本地二级索引的摘要字段。支持创建多个摘要。摘要的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。单击“创建全局二级索引”，配置参数信息如表2所示。确认配置信息后单击“确定”。图2 “创建全局二级索引”界面表2 “创建全局二级索引”参数说明类别参数名称描述创建全局二级索引名称必选参数。全局二级索引的名称。名称的长度范围为1-255个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”、“.”组成。名称不支持设置为“XPriIndex”。分区键必选参数。分区键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。排序键可选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。摘要可选参数。全局二级索引的摘要字段。支持创建多个摘要。摘要的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。信息设置完成后，单击“确定”。

键值存储服务 KVS

键值存储服务 KVS-删除索引:操作步骤

操作步骤登录KVS管理控制台。在KVS管理控制台左侧导航栏选择“仓”，进入存储仓列表。在仓列表中找到需要删除索引的表所在的仓，在仓对应的操作列，单击“创建表”，或者单击仓名称进入仓的详情页面，在“表信息”下单击“创建表”。根据界面提示，填写表详细信息。根据界面提示，配置“二级索引”。支持创建本地二级索引或全局二级索引。单击“创建本地二级索引”，配置参数信息如表1所示。确认配置信息后单击“确定”。图1 “创建本地二级索引”界面表1 “创建本地二级索引”参数说明类别参数名称描述创建本地二级索引名称必选参数。本地二级索引的名称。名称的长度范围为1-255个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”、“.”组成。名称不支持设置为“XPriIndex”。排序键必选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。摘要可选参数。本地二级索引的摘要字段。支持创建多个摘要。摘要的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。单击“创建全局二级索引”，配置参数信息如表2所示。确认配置信息后单击“确定”。图2 “创建全局二级索引”界面表2 “创建全局二级索引”参数说明类别参数名称描述创建全局二级索引名称必选参数。本地全局索引的名称。名称的长度范围为1-255个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”、“.”组成。名称不支持设置为“XPriIndex”。分区键必选参数。分区键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。排序键可选参数。排序键的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。摘要可选参数。全局二级索引的摘要字段。支持创建多个摘要。摘要的长度范围为1-63个字符，由数字0-9、字符a-z、A-Z，及特殊符“-”、“_”组成。首字母不支持设置为“_”。在“二级索引”区域，单击二级索引操作列的“删除”，即可删除已创建的本地二级索引或全局二级索引。图3 删除索引

键值存储服务 KVS 索引管理

键值存储服务 KVS-表简介

表简介表是用来存储键值数据（Key-Value，简称KV）的集合，归属于某个仓。用户可以在一个仓中创建至少1个或多个表，用来储存键值数据。例如，用某个仓记录公司内所有员工的信息，那么可以用这个仓中的每一个表记录每一个部门内所有员工的信息。图1 表简介 KVS云服务支持创建表，查询所有表及详细信息。表1 KVS云服务支持的表相关功能功能描述创建表在指定存储仓创建表，同时指定索引。查询表在指定存储仓查询所有表。查询表详细信息在指定存储仓查看某个表的详情父主题：表管理

键值存储服务 KVS 表管理

键值存储服务 KVS-创建表:响应示例

响应示例状态码： 200 表示创建表成功。 { "table_name" : "test-table", "primary_key_schema" : { "shard_key_fields" : [ { "name" : "owner", "order" : true } ], "sort_key_fields" : [ { "name" : "filename", "order" : true } ] } }

键值存储服务 KVS 仓接口

键值存储服务 KVS-创建表:请求示例

请求示例创建表，表名为test-table，分区键字段名为owner，排序键字段名称为filename POST https://{endpoint}/v1/create-table { "table_name" : "test-table", "primary_key_schema" : { "shard_key_fields" : [ { "name" : "owner", "order" : true } ], "sort_key_fields" : [ { "name" : "filename", "order" : true } ] } }

键值存储服务 KVS 仓接口

键值存储服务 KVS-创建表:响应参数

响应参数状态码： 200 表9 响应Body参数参数参数类型描述 table_name String 表名，仓内唯一。 bill_mode String 计费模式，可为"provisioned"或"on_demand"。 provisioned_throughput provisioned_throughput object 预置吞吐读写请求单元数，在bill_mode="provisioned"有效。 primary_key_schema primary_key_schema object 主键模板, 最多1个，必须指定主键schema。 local_secondary_index_schema Array of secondary_index objects 本地二级索引模板，可以多个。 global_secondary_index_schema Array of global_secondary_index objects 全局二级索引模板。 pre_split_key_options pre_split_key_options object 按照设定的分裂键值或者键值前缀进行预分裂。说明： range分区时该参数有效，且只作用于主表，其他场景无效。表10 primary_key_schema 参数参数类型描述 shard_key_fields Array of field objects 分区键字段名数组，顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。表11 secondary_index 参数参数类型描述 index_name String 二级索引名称，表内唯一。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 abstract_fields Array of strings 摘要字段名数组。表12 global_secondary_index 参数参数类型描述 index_name String 二级索引名称，表内唯一。 shard_key_fields Array of field objects 分区键字段名数组，顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 abstract_fields Array of strings 摘要字段名数组。 provisioned_throughput provisioned_throughput object 预置吞吐读写请求单元数，在bill_mode="provisioned"有效。表13 field 参数参数类型描述 name String 字段名。 order Boolean bool值预留无意义。表14 provisioned_throughput 参数参数类型描述 rcu Long 预置表级读请求单元数。 wcu Long 预置表级写请求单元数。表15 pre_split_key_options 参数参数类型描述 range_split_points Array of strings 在range分区模式有效，最大10个。状态码： 400 表16 响应Body参数参数参数类型描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。状态码： 409 表17 响应Body参数参数参数类型描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。

键值存储服务 KVS 仓接口

键值存储服务 KVS-创建表:请求参数

请求参数表2 请求Body参数参数是否必选参数类型描述 table_name 是 String 表名，仓内唯一。 bill_mode 否 String 表计费模式，可为"provisioned"或"on_demand" 预置模式：provisioned 按需模式：on_demand provisioned_throughput 否 provisioned_throughput object 预置吞吐读写请求单元数，在bill_mode="provisioned"有效。 primary_key_schema 是 primary_key_schema object 主键模板, 最多1个，必须指定主键schema。 local_secondary_index_schema 否 Array of secondary_index objects 本地二级索引模板，可以多个。 global_secondary_index_schema 否 Array of global_secondary_index objects 全局二级索引模板。 pre_split_key_options 否 pre_split_key_options object 按照设定的分裂键值或者键值前缀进行预分裂。说明： range分区时该参数有效，且只作用于主表，其他场景无效。表3 primary_key_schema 参数是否必选参数类型描述 shard_key_fields 是 Array of field objects 分区键字段名数组，顺序组合。 shard_mode 否 String 分区模式。 sort_key_fields 否 Array of field objects 排序键字段名数组，顺序组合。表4 secondary_index 参数是否必选参数类型描述 index_name 是 String 二级索引名称，表内唯一。 sort_key_fields 是 Array of field objects 排序键字段名数组，顺序组合。 abstract_fields 否 Array of strings 摘要字段名数组。表5 global_secondary_index 参数是否必选参数类型描述 index_name 是 String 二级索引名称，表内唯一。 shard_key_fields 是 Array of field objects 分区键字段名数组，顺序组合。 shard_mode 否 String 分区模式。 sort_key_fields 否 Array of field objects 排序键字段名数组，顺序组合。 abstract_fields 否 Array of strings 摘要字段名数组。 provisioned_throughput 否 provisioned_throughput object 预置吞吐读写请求单元数，在bill_mode="provisioned"有效。表6 field 参数是否必选参数类型描述 name 是 String 字段名。 order 否 Boolean bool值预留无意义。表7 provisioned_throughput 参数是否必选参数类型描述 rcu 是 Long 预置表级读请求单元数。 wcu 是 Long 预置表级写请求单元数。表8 pre_split_key_options 参数是否必选参数类型描述 range_split_points 否 Array of strings 在range分区模式有效，最大10个。

键值存储服务 KVS 仓接口

键值存储服务 KVS-创建表:URI

URI POST /v1/create-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-查询表:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 table_name String 表名。长度：[3, 63] 取值字符限制：[a-z0-9_-]+ primary_key_schema primary_key_schema object 主键模板, 最多1个，必须指定主键schema。 local_secondary_index_schema Array of secondary_index objects 本地二级索引模板，可以多个。 global_secondary_index_schema Array of global_secondary_index objects 全局二级索引模板。 run_time_info run_time_info object 运行信息。表4 primary_key_schema 参数参数类型描述 shard_key_fields Array of field objects 分区键字段名数组，顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。表5 secondary_index 参数参数类型描述 index_name String 二级索引名称，表内唯一。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 abstract_fields Array of strings 摘要字段名数组。表6 global_secondary_index 参数参数类型描述 index_name String 二级索引名称，表内唯一。 shard_key_fields Array of field objects 分区键字段名数组，顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 abstract_fields Array of strings 摘要字段名数组。 provisioned_throughput provisioned_throughput object 预置吞吐读写请求单元数，在bill_mode="provisioned"有效。表7 field 参数参数类型描述 name String 字段名。 order Boolean bool值预留无意义。表8 provisioned_throughput 参数参数类型描述 rcu Long 预置表级读请求单元数。 wcu Long 预置表级写请求单元数。表9 run_time_info 参数参数类型描述 table_info table_info object 表信息。 local_secondary_index_infos Array of secondary_index_info objects 索引状态。 global_secondary_index_infos Array of global_secondary_index_info objects 全局二级索引运行态。表10 table_info 参数参数类型描述 table_status String 表状态。 "creating" "active" "deleting" 表11 secondary_index_info 参数参数类型描述 index_name String 索引状态。长度：[1, 255] 取值字符限制：[a-z0-9_-]+ index_status String 索引状态。 "creating" "active" "deleting" 表12 global_secondary_index_info 参数参数类型描述 index_name String 二级索引名称。 index_status String 二级索引名称。 "creating" "active" "deleting" 状态码： 400 表13 响应Body参数参数参数类型描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。

键值存储服务 KVS 表接口

键值存储服务 KVS-查询表:响应示例

响应示例状态码： 200 表示查询表请求成功 { "table_name" : "test-table-1", "primary_key_schema" : { "shard_key_fields" : [ { "name" : "owner", "order" : true } ], "sort_key_fields" : [ { "name" : "filename", "order" : true } ] }, "runtime_info" : { "table_info" : { "table_status" : "ACTIVE" } } }

键值存储服务 KVS 表接口

键值存储服务 KVS-查询表:URI

URI POST /v1/describe-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-扫描所有kv:响应参数

响应参数状态码： 200 表8 响应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列表。表9 returned_kv_item 参数参数类型描述 kv_doc Document 对kv_doc有效。

键值存储服务 KVS KV接口

键值存储服务 KVS-扫描所有kv:请求示例

请求示例扫描所有kv，扫描条件为分区键的值为user2 POST https://{endpoint}/v1/scan-kv { "table_name" : "test-table-1", "filter_expression" : { "single_field_expr" : { "field" : "owner", "func" : "$eq", "value" : { "value" : "user-2" } } } }

键值存储服务 KVS KV接口

云服务器内容精选

键值存储服务 KVS

7*24

备案

专业服务

退订

建议反馈

售前咨询热线