すべてのプロダクト
Search
ドキュメントセンター

DataWorks:GetMetaDBInfo

最終更新日:Aug 20, 2026

エンジンインスタンスの基本的なメタデータ情報を取得します。

操作説明

開始する前に: この操作を呼び出す前に、DataWorks Enterprise Edition または Ultimate Edition を有効化してください。エディションが有効化されていない場合、サービスは 403 Forbidden.Access を返します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

AppGuid

string

任意

エンジン ID。フォーマットは エンジンタイプ.エンジン名 です。

odps.some_engine_name

ClusterId

string

任意

EMR クラスターのクラスター ID。

abc

DatabaseName

string

任意

EMR クラスターのデータベース。

abc

DataSourceType

string

任意

データの型。有効な値: odps、emr。

emr

レスポンスフィールド

フィールド

型

説明

例

object

応答。

RequestId

string

リクエスト ID。

0bc1411515937****

Data

object

基本的なメタデータ情報。

Type

string

データベースのタイプ。

hive

Comment

string

コメント。

コメント

CreateTime

integer

エンジンが作成された時間。

値は 13 桁の数値です (例: 1541576644000)。

1541576644000

ProjectId

integer

ワークスペースの ID。

22

ProjectName

string

ワークスペースの名前。

test

AppGuid

string

エンジン ID。フォーマットは エンジンタイプ.エンジン名 です。

odps.engine_name

OwnerName

string

ワークスペースのオーナーの名前。

my_name

OwnerId

string

ワークスペースのオーナーの Alibaba Cloud アカウント ID。

userId

EnvType

integer

環境のタイプ。値が 0 の場合は非本番テーブルを示し、値が 1 の場合は本番テーブルを示します。

1

ProjectNameCn

string

ワークスペースの表示名。

テストプロジェクト

Endpoint

string

サービスのエンドポイント。

http://service.odpsstg.aliyun-inc.com/

ClusterBizId

string

EMR クラスターの ID。

abc

Name

string

データベース名。

abc

Location

string

EMR データベースのデータストレージの場所。

hdfs://

TenantId

integer

テナント ID。

233

ModifyTime

integer

エンジンが変更済みの時間。

値は 13 桁の数値です (例: 1541576644000)。

1541576644000

例

成功レスポンス

JSONJSON

{
  "RequestId": "0bc1411515937****",
  "Data": {
    "Type": "hive",
    "Comment": "Remarks",
    "CreateTime": 1541576644000,
    "ProjectId": 22,
    "ProjectName": "test",
    "AppGuid": "odps.engine_name",
    "OwnerName": "my_name",
    "OwnerId": "userId",
    "EnvType": 1,
    "ProjectNameCn": "测试项目",
    "Endpoint": "http://service.odpsstg.aliyun-inc.com/",
    "ClusterBizId": "abc",
    "Name": "abc",
    "Location": "hdfs://",
    "TenantId": 233,
    "ModifyTime": 1541576644000
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid.Meta.AppNotExist The MaxCompute project 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 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.
400 InvalidParameter.Meta.NotExist The data does not exist.
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 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.

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

変更履歴

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