DescribeTairSkvDdbTableSchema - - Alibaba Cloud ドキュメントセンター

操作説明

操作の説明

この操作は、Tair サーバーレス KV テーブルインスタンスのテーブルスキーマと構成情報をクエリします。
InstanceId パラメーターを指定する必要があります。このパラメーターをクエリするインスタンスのインスタンス ID に設定します。
BackupId パラメーターは、クエリするテーブルのバックアップセットを指定します。
応答パケットには、TTL (Time-to-Live) の仕様と詳細なテーブルスキーマの解像度が含まれます。

この操作を呼び出すには、以下のリクエストパラメーターを参照してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeTairSkvDdbTableSchema

get

*DBInstance

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

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	クエリするインスタンスの ID。	tt-bp1zxszhcgatnx\\\\\\\\
BackupId	string	任意	バックアップファイルの ID。	78241****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエスト ID。詳細については、共通パラメーターを参照してください。	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}

TTL の仕様には、時間ベースの有効期限セットが含まれます。

{
		"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\"}]}"
	}

例

成功レスポンス

JSONJSON

{
  "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}"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。