DescribeTairSkvDdbTableSchema - 查询Tair Serverless KV表结构 - 云数据库 Tair（兼容 Redis®）

接口说明

请求说明

本接口用于查询一个 Tair Serverless KV 的 table 实例的表结构配置信息。
调用时必须提供InstanceId参数，且该参数值为需要查询的具体实例 ID。
BackupId参数指定了要查询的表备份集。
返回的数据包括表的生存时间(TTL)规格和详细的表结构定义。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:DescribeTairSkvDdbTableSchema

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	需要查询的实例 ID。	tt-bp1zxszhcgatnx\\\\\\\\
BackupId	string	否	备份文件的 ID。	78241****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	详见公共参数。	A1604E1B-6825-1577-BBDA-2A64E8D5F126
Schema	string	json 形式的表结构信息	{"attributeDefinitions":[{"attributeType":"S","attributeName":"pk"},{"attributeType":"S","attributeName":"sk"}],"keySchema":[{"attributeName":"pk","keyType":"HASH"},{"attributeName":"sk","keyType":"RANGE"}]}
TtlSpec	string	TTL 属性，json 形式的配置参数配置开关	{"attributeName":"Expiretime","enabled":true}

{
		"TtlSpec":"{\"attributeName\":\"Expiretime\",\"enabled\":true}",
		"RequestId":"A1604E1B-6825-1577-BBDA-2A64E8D5F126",
		"Schema":"{\"attributeDefinitions\":[{\"attributeType\":\"S\",\"attributeName\":\"pk\"},{\"attributeType\":\"S\",\"attributeName\":\"sk\"}],\"keySchema\":[{\"attributeName\":\"pk\",\"keyType\":\"HASH\"},{\"attributeName\":\"sk\",\"keyType\":\"RANGE\"}]}"
	}

示例

正常返回示例

JSON格式

{
  "RequestId": "A1604E1B-6825-1577-BBDA-2A64E8D5F126",
  "Schema": "{\"attributeDefinitions\":[{\"attributeType\":\"S\",\"attributeName\":\"pk\"},{\"attributeType\":\"S\",\"attributeName\":\"sk\"}],\"keySchema\":[{\"attributeName\":\"pk\",\"keyType\":\"HASH\"},{\"attributeName\":\"sk\",\"keyType\":\"RANGE\"}]}",
  "TtlSpec": "{\"attributeName\":\"Expiretime\",\"enabled\":true}"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。