SearchMetaTables でメタテーブルをクエリする - DataWorks

特定の条件に基づいてメタテーブルをクエリします。

操作説明

MaxCompute および EMR のみ、対応するエンジンテーブルの検索が可能です。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号です。	1
PageSize	integer	任意	1 ページあたりの表示件数です。デフォルト値は 10、最大値は 100 です。	10
AppGuid	string	任意	メタテーブルが存在するワークスペースの GUID です。	odps.engine_name
Keyword	string	必須	メタテーブルを検索するためのキーワードです。検索時に、システムはメタテーブル名をトークン化し、キーワードと照合します。一致する名前がない場合、値 null が返されます。デフォルトでは、アンダースコア (_) を使用して名前をトークン化します。	test
EntityType	integer	任意	メタテーブルの種別です。有効な値は 0 および 1 です。0 はテーブルの検索を示し、1 はビューの検索を示します。このパラメーターを設定しない場合、すべての種別のメタテーブルが検索対象となります。	0
ClusterId	string	任意	EMR クラスターの ID です。DataSourceType パラメーターを emr に設定した場合にのみ、このパラメーターを指定する必要があります。 ID は、EMR コンソールにログインして確認できます。	abc
DataSourceType	string	任意	データソースの種別です。有効な値は odps および emr です。	emr
Schema	string	任意	テーブルのスキーマ情報です。MaxCompute の 3 層モデルを有効化している場合は、このパラメーターを設定する必要があります。	default

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
HttpStatusCode	integer	HTTP ステータスコードです。	200
ErrorMessage	string	エラーメッセージです。	The specified parameters are invalid.
RequestId	string	リクエスト ID です。	0bc1ec92159376****
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrorCode	string	エラーコードです。	1031203110005
Data	object	検索結果です。
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりの表示件数です。	10
TotalCount	integer	メタテーブルの総件数です。	100
DataEntityList	array<object>	メタテーブルの一覧です。
	object
TableName	string	メタテーブルの名前です。	test_name
DatabaseName	string	メタデータベースの名前です。	abc
EntityType	integer	メタテーブルの種別です。有効な値は以下のとおりです。 0：テーブル 1：ビュー	0
ProjectName	string	ワークスペースの名前です。	test
ProjectId	integer	ワークスペースの ID です。	323
TableGuid	string	メタテーブルの GUID です。	odps.engine_name.test_name
OwnerId	string	ワークスペース所有者が使用する Alibaba Cloud アカウントの ID です。	123
ClusterId	string	EMR クラスターの ID です。	abc
EnvType	integer	環境の種別です。有効な値は以下のとおりです。 1：本番環境 0：開発環境	1
TenantId	integer	テナント ID です。	12345
Schema	string	テーブルのスキーマ情報です。MaxCompute の 3 層モデルを有効化している場合は、このパラメーターを設定する必要があります。	default

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0bc1ec92159376****",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "DataEntityList": [
      {
        "TableName": "test_name",
        "DatabaseName": "abc",
        "EntityType": 0,
        "ProjectName": "test",
        "ProjectId": 323,
        "TableGuid": "odps.engine_name.test_name",
        "OwnerId": "123",
        "ClusterId": "abc",
        "EnvType": 1,
        "TenantId": 12345,
        "Schema": "default"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.Meta.TableNotExist	The table does not exist.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.
403	ResourceNotAuthorized.Api	You are not authorized to access the resources.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

変更履歴

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