すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateMetaEntityDef

    ドキュメントセンター

    DataWorks:CreateMetaEntityDef

    最終更新日:Sep 03, 2026

    メタデータエンティティ定義を作成します。カスタムタイプおよび拡張テーブルタイプを含みます。

    操作説明

    DataWorks Professional Edition 以上のエディションが必須です。

    今すぐお試しください

    この 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:CreateMetaEntityDef

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    必須

    タイプ定義の名前。カスタムタイプは ^[a-z0-9][a-z0-9_]*$ に一致する必要があります。拡張テーブルタイプは ^[a-z0-9][a-z0-9_]*-table$ に一致する必要があります。

    biz_api
    DisplayName

    string

    必須

    表示名（最大 32 文字）。

    Business API
    Description

    string

    任意

    説明。

    description
    Extend

    string

    任意

    拡張モード。有効な値:

    • NONE: デフォルト値。自由に定義された属性を持つカスタムエンティティを示します。

    • TABLE: 拡張テーブルタイプを示します。このタイプは、DataWorks データマップ内の既存のテーブルタイプと同じ方法で統合されます。属性定義を提供する必要はなく、対応するデータベース/テーブルオブジェクトを作成できます。

    列挙値:

    • TABLE :

      拡張テーブルエンティティ。

    • NONE :

      カスタムエンティティ。

    TABLE
    AttributeDefs

    array

    任意

    カスタムエンティティの属性定義リスト。extend が TABLE に設定されている場合、このパラメーターは指定できません。

    []
    MetaEntityAttributeDef

    任意

    属性定義。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    0A04C673-BEFA-5803-94E5-89E2D9F8C567
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    EntityType

    string

    作成後のエンティティタイプ。

    custom_entity-biz_api

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0A04C673-BEFA-5803-94E5-89E2D9F8C567",
  "Success": true,
  "EntityType": "custom_entity-biz_api"
}

    エラーコード

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

    変更履歴

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