DescribeTairSkvDdbTable -

此 API 用於查詢指定 Workspace 下的所有 Tair Serverless KV 的 table 執行個體。

介面說明

請求說明

呼叫本介面時，必須提供 InstanceId 參數。
傳回結果中包含每個資料表的基本資訊如資料表 ID、名稱、頻寬及最大連線數等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeTairSkvDdbTable

get

*DBInstance

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

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	需要查詢的執行個體 ID。	tt-bp1zxszhcgatnx\\\\

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID，用於定位日誌，排查問題。	2363CEDF-C697-14B6-AB9E-C57A4AA0EAD4
Tables	object
Table	array<object>	由 Table 組成的陣列。
	array<object>	table 物件。
Bandwidth	integer	頻寬。	96
Connections	integer	最大連線數。	1000
GlobalSecondaryIndexList	object
GlobalSecondaryIndex	array<object>	table 下的所有 gsiId 的清單。
	object	gsi 物件。
GsiId	string	GSI 執行個體 ID（全域唯一）。	tt-gsi-xxxxxxxxx
IndexName	string	索引名稱。	indexKey1
TableId	string	資料表 ID（全域唯一）。	tt-2zelkttksbyc12x6c
TableName	string	資料表名稱（Workspace 下唯一）。	table1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2363CEDF-C697-14B6-AB9E-C57A4AA0EAD4",
  "Tables": {
    "Table": [
      {
        "Bandwidth": 96,
        "Connections": 1000,
        "GlobalSecondaryIndexList": {
          "GlobalSecondaryIndex": [
            {
              "GsiId": "tt-gsi-xxxxxxxxx",
              "IndexName": "indexKey1"
            }
          ]
        },
        "TableId": "tt-2zelkttksbyc12x6c",
        "TableName": "table1"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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