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

DataAgent ワークスペース内で特定のタグに関連付けられたデータベースおよびテーブルアセットの一覧を取得します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナント ID です。説明コンソール右上隅のプロフィール画像にカーソルを合わせることで、ご利用のテナント 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`：Data Management (DMS) 内のデータベース ID です。 `instanceResourceId`：インスタンスのリソース ID です。該当インスタンスが ApsaraDB RDS インスタンスの場合、これは RDS インスタンス ID となります。 `dbType`：Data Management (DMS) 内のデータベース種別です。 `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
}

エラーコード

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

変更履歴

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