DescribeTairSkvDdbTableSchema -

介面說明

請求說明

本介面用於查詢一個 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}"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。