ListTables - Data Management (DMS) - Alibaba Cloud - Data Management - Alibaba Cloud ドキュメントセンター

データベース内のすべてのテーブルの詳細を一覧表示します。

操作説明

この 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:ListTables

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナント ID。この ID は、GetUserActiveTenant または ListUserTenants を呼び出すことで取得できます。	3***
DatabaseId	string	必須	物理データベースの ID。この ID は、ListDatabases または SearchDatabase を呼び出すことで取得できます。	1860****
PageNumber	integer	任意	返されるページ番号。	1
PageSize	integer	任意	ページあたりのエントリ数。	10
SearchName	string	任意	テーブル名のあいまい検索に使用するキーワード。	test
ReturnGuid	boolean	任意	テーブルのグローバル一意識別子 (GUID) を返すかどうかを指定します。有効な値： true：テーブルの GUID を返します。 false：テーブルの GUID を返しません。	true
RealLoginUserUid	string	任意	API を呼び出すユーザーの ID。	1234

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	条件に一致するテーブルの総数。	1
RequestId	string	リクエスト ID。	B16FB618-5E96-4FFD-BB0D-490C890A4030
ErrorCode	string	エラーコード。	UnknownError
TableList	object
Table	array<object>	テーブルのリスト。
	array<object>
DatabaseId	string	物理データベースの ID。	1860****
TableName	string	テーブル名。	consumption_records
StoreCapacity	integer	テーブルが使用するおおよそのストレージ容量 (MB 単位)。	1024
OwnerIdList	object
OwnerIds	array	テーブルオーナーのユーザー ID。
	string	テーブルオーナーのユーザー ID。	51****
Description	string	テーブルの説明。	test
Encoding	string	テーブルのエンコーディング。	utf8
OwnerNameList	object
OwnerNames	array	テーブルオーナーのニックネーム。
	string	テーブルオーナーのニックネーム。	owner_name
TableSchemaName	string	テーブルが含まれるデータベース。	qntest
TableType	string	テーブルのタイプ。デフォルト：NORMAL。	NORMAL
TableGuid	string	DMS でのテーブルの GUID。	IDB_44743****.qntest.consumption_records
Engine	string	テーブルエンジン。	InnoDB
NumRows	integer	テーブル内の推定行数。	10085
TableId	string	テーブル ID。	44743****
ErrorMessage	string	エラーメッセージ。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "RequestId": "B16FB618-5E96-4FFD-BB0D-490C890A4030",
  "ErrorCode": "UnknownError",
  "TableList": {
    "Table": [
      {
        "DatabaseId": "1860****",
        "TableName": "consumption_records",
        "StoreCapacity": 1024,
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "Description": "test",
        "Encoding": "utf8",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "TableSchemaName": "qntest",
        "TableType": "NORMAL",
        "TableGuid": "IDB_44743****.qntest.consumption_records",
        "Engine": "InnoDB",
        "NumRows": 10085,
        "TableId": "44743****"
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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