すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateCustomAttribute

    ドキュメントセンター

    DataWorks:CreateCustomAttribute

    最終更新日:Sep 03, 2026

    カスタム属性の定義を作成します。

    今すぐお試しください

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

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    string

    必須

    カスタム属性 ID。値は ^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$ に一致する必要があります。custom-attribute: の後の部分は 100 文字未満である必要があります。

    custom-attribute:biz_owner
    DisplayName

    string

    必須

    カスタム属性の表示名。値の長さは 128 文字未満である必要があります。

    BusinessOwner
    Type

    string

    必須

    カスタム属性のタイプ。有効な値: ENUM、TEXT、HYPERLINK。

    列挙値:

    • ENUM :

      列挙タイプ。

    • HYPERLINK :

      ハイパーリンクタイプ。

    • TEXT :

      テキストタイプ。

    TEXT
    EntityTypes

    array

    必須

    適用対象エンティティタイプのリスト。正確なエンティティタイプおよび *-table や *-column などのワイルドカードパターンがサポートされています。例:

    • dataworks-project: ワークスペース

    • dataworks-dataset: DataWorks データセット

    • maxcompute-table: MaxCompute テーブル

    • *-column: すべてのカラムタイプ

    string

    任意

    エンティティタイプ。

    maxcompute-table
    ValueEnums

    array

    任意

    列挙値。このパラメーターは、タイプが ENUM に設定されている場合に必須です。このパラメーターは、TEXT または HYPERLINK タイプではサポートされていません。

    string

    任意

    列挙値。

    VALUE_1
    DisplayEnabled

    boolean

    任意

    詳細ページに属性を表示するかどうかを指定します。デフォルト値: true。

    true
    SearchFilterEnabled

    boolean

    任意

    DataWorks データマップ検索ページで属性をフィルター条件として使用できるかどうかを指定します。デフォルト値: false。現在、この値を true に設定できるのは ENUM タイプのみです。

    false
    Comment

    string

    任意

    カスタム属性の説明。値の長さは 256 文字未満である必要があります。

    test comment

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71
    Success

    boolean

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

    true
    Result

    boolean

    作成結果。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71",
  "Success": true,
  "Result": true
}

    エラーコード

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

    変更履歴

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