GetMetaTableDetailInfo：スキーマ監査用のカラムとインデックスメタデータの取得 - DMS - Alibaba Cloud - Data Management

GetMetaTableDetailInfo 操作を呼び出して、フィールドやインデックスなど、テーブルの詳細情報を取得します。

操作説明

この API は、セキュリティコラボレーションコントロールモードのデータベースインスタンスのみが呼び出すことができます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:GetMetaTableDetailInfo

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナント ID です。説明テナント ID は、コンソールの右上のプロフィール画像にカーソルを合わせると確認できます。詳細については、「テナント情報の表示」をご参照ください。	123
TableGuid	string	必須	DMS 内のテーブルの GUID です。説明論理データベースの場合は、ListLogicTables 操作を呼び出し、ReturnGuid パラメーターを true に設定します。物理データベースの場合は、ListTables 操作を呼び出し、ReturnGuid パラメーターを true に設定します。	IDB_L_9032.db-test.yuyang_test
RealLoginUserUid	string	任意	API 呼び出し元のユーザー ID です。	12345

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	E881CB2F-DE42-42E5-90EB-8B3173DCB9B9
DetailInfo	object	テーブルの詳細です。
IndexList	array<object>	インデックスリストです。
	object
IndexColumns	array	インデックスキー列のリストです。
	string	インデックスキー列です。	id
IndexName	string	インデックス名です。	PRIMARY
Unique	boolean	インデックスが一意であるかどうかを示します。有効な値： `true`：インデックスは一意です。 `false`：インデックスは一意ではありません。	false
IndexType	string	インデックスのタイプです。例：`Primary`、`Unique`、`Normal`。	Primary
IndexId	string	インデックス ID です。	123
ColumnList	array<object>	列リストです。
	object
ColumnName	string	列名です。	id
Description	string	列の説明です。	test
DataScale	integer	列のスケール (小数点以下の桁数) です。	0
DataPrecision	integer	列の精度 (数値の総桁数) です。	0
ColumnType	string	列のデータの型です。例：`Bigint`、`Int`、`Varchar`。	bigint(20) unsigned
AutoIncrement	boolean	列が自動インクリメントされるかどうかを示します。有効な値： `true`：列は自動インクリメントされます。 `false`：列は自動インクリメントされません。	true
Position	string	テーブル内での列の位置です。	1
Nullable	boolean	列に NULL 値を含めることができるかどうかを示します。有効な値： `true`：列に NULL 値を含めることができます。 `false`：列に NULL 値を含めることはできません。	false
ColumnId	string	列 ID です。	191234849
DataLength	integer	列のデータ長です。	0
ErrorCode	string	エラーが発生した場合に返されるエラーコードです。	UnknownError
ErrorMessage	string	エラーが発生した場合に返されるエラーメッセージです。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9",
  "DetailInfo": {
    "IndexList": [
      {
        "IndexColumns": [
          "id"
        ],
        "IndexName": "PRIMARY",
        "Unique": false,
        "IndexType": "Primary",
        "IndexId": "123"
      }
    ],
    "ColumnList": [
      {
        "ColumnName": "id",
        "Description": "test",
        "DataScale": 0,
        "DataPrecision": 0,
        "ColumnType": "bigint(20) unsigned",
        "AutoIncrement": true,
        "Position": "1",
        "Nullable": false,
        "ColumnId": "191234849",
        "DataLength": 0
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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