键值存储服务 KVS-查询表:响应参数

时间:2024-05-07 09:20:02

响应参数

状态码: 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

摘要字段名数组。

表7 field

参数

参数类型

描述

name

String

字段名。

order

Boolean

bool值预留无意义。

表8 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

全局二级索引运行态。

表9 table_info

参数

参数类型

描述

table_status

String

表状态。

  • "creating"

  • "active"

  • "deleting"

表10 secondary_index_info

参数

参数类型

描述

index_name

String

索引状态。

  • 长度:[1, 255]

  • 取值字符限制:[a-z0-9_-]+

index_status

String

索引状态。

  • "creating"

  • "active"

  • "deleting"

表11 global_secondary_index_info

参数

参数类型

描述

index_name

String

二级索引名称。

index_status

String

二级索引名称。

  • "creating"

  • "active"

  • "deleting"

状态码: 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

请求返回的错误码。

error_msg

String

请求返回的错误信息。

support.huaweicloud.com/api-kvs/DescribeTable.html