スキーマ取得用 GetSchema API リファレンス - DataWorks - Alibaba Cloud - DataWorks

Data Map 内のスキーマ情報をクエリします。この API オペレーションを呼び出すことで、MaxCompute および Hologres のスキーマ情報のみをクエリできます。

操作説明

DataWorks 基本版以上のバージョンをご購入いただく必要があります。
現在、MaxCompute および Hologres タイプがサポートされています。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	必須	ID です。「ListSchemas」オペレーションおよび「メタデータエンティティに関する概念」をご参照ください。フォーマットは `${EntityType}:${Instance ID or escaped URL}:${Catalog ID}:${Database name}:${Schema name}</code>` です。存在しない階層には空文字列をプレースホルダーとして使用します。説明 MaxCompute タイプの場合、インスタンス ID 階層には空文字列をプレースホルダーとして使用します。データベース名は MaxCompute プロジェクト名であり、プロジェクトでは 3 階層モデルが有効になっている必要があります。例： `maxcompute-schema:::project_name:schema_name`（MaxCompute プロジェクトで 3 階層モデルが有効） `holo-schema:instance_id::database_name:schema_name` 説明 `instance_id`：Hologres インスタンス ID . `database_name`：データベース名 . `database_name`：MaxCompute プロジェクト名 . `schema_name`：スキーマ名	maxcompute-schema:::project_name:schema_name

レスポンスフィールド

フィールド	型	説明	例
	object	応答です。
RequestId	string	リクエスト ID です。	A89B5D9D-74EA-XXXXXX
Success	boolean	リクエストが成功したかどうかを示します。	true
Schema	Schema	スキーマ情報です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "A89B5D9D-74EA-XXXXXX",
  "Success": true,
  "Schema": {
    "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
    "Name": "test_db",
    "Comment": "test comment",
    "Type": "MANAGED",
    "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

エラーコード

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

変更履歴

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