ListTagMetaAsset - Data Management - Alibaba Cloud ドキュメントセンター

DataAgent ワークスペース内の特定のタグに関連付けられているデータベースおよびテーブルアセットをリストアップします。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID。説明 Data Management Service (DMS) コンソールの右上隅にあるプロフィール画像にポインターを合わせると、テナント ID を確認できます。詳細については、「テナント情報の表示」をご参照ください。	3***
TagName	string	必須	タグの名前。DataAgent ワークスペースからデータベースおよびテーブルアセットを取得するには、タグ名を `sys::DMS-DA::${DataAgentRegionId}::space:${DataAgentWorkspaceId}` のフォーマットで指定します。	sys::DMS-DA::cn-hangzhou::space:abcde
MetaType	string	必須	`META_DATABASE` を指定してデータベースを取得します。 `META_TABLE` を指定して特定のデータベース内のテーブルを取得します。	META_DATABASE
MetaParentId	string	任意	親アセットの ID。このパラメーターを省略すると、データベースが取得されます。特定のデータベース内のテーブルを取得するには、このパラメーターをデータベースの `dbId` に設定します。	123456
SearchKey	string	任意	あいまい検索用のキーワード。	test
PageNumber	integer	必須	ページ番号。	1
PageSize	integer	必須	1ページあたりのエントリ数。	50

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	失敗したリクエストのエラーコード。	UnknownError
ErrorMessage	string	失敗したリクエストのエラーメッセージ。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
Data	array<object>	アセットのリスト。
	array<object>
MetaType	string	`META_DATABASE`：アセットはデータベースです。 `META_TABLE`：アセットはテーブルです。	META_DATABASE
MetaEntityAttrs	object	`MetaType` が `META_DATABASE` の場合、このオブジェクトには次のフィールドが含まれます： `schemaName`：データベースの名前。PostgreSQL 互換のデータベースの場合、このフィールドはスキーマ名を示します。 `catalogName`：カタログの名前。このフィールドは PostgreSQL 互換のデータベースにのみ適用されます。 `dbId`：DMS におけるデータベースの ID。 `instanceResourceId`：インスタンスのリソース ID。データベースが ApsaraDB RDS インスタンス内にある場合、このフィールドは RDS インスタンスの ID を示します。 `dbType`：DMS におけるデータベースのタイプ。 `MetaType` が `META_TABLE` の場合、このオブジェクトには次のフィールドが含まれます： `schemaName`：テーブルを含むデータベースの名前。PostgreSQL 互換のデータベースの場合、このフィールドはスキーマ名を示します。 `catalogName`：カタログの名前。このフィールドは PostgreSQL 互換のデータベースにのみ適用されます。 `dbId`：DMS におけるデータベースの ID。 `dbType`：DMS におけるデータベースのタイプ。 `tableName`：テーブルの名前。 `tableSchemaName`：テーブルスキーマの名前。このフィールドは SQL Server でのみ有効です。	{"schemaName": "test"}
TotalCount	integer	一致するエントリの総数。	100

例

成功レスポンス

JSONJSON

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": [
    {
      "MetaType": "META_DATABASE",
      "MetaEntityAttrs": {
        "schemaName": "test"
      }
    }
  ],
  "TotalCount": 100
}

エラーコード

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

変更履歴

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