全部產品
Search

搜尋本產品

    DataWorks：CreateCustomAttribute

    文件中心

    DataWorks：CreateCustomAttribute

    更新時間：Sep 03, 2026

    建立自訂屬性定義。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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 個字元。

    業務負責人
    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

    否

    列舉可選值，type=ENUM 時必填；TEXT、HYPERLINK 類型不支援。

    string

    否

    列舉可選值。

    VALUE_1
    DisplayEnabled

    boolean

    否

    是否在詳細資訊頁顯示，預設為 true。

    true
    SearchFilterEnabled

    boolean

    否

    是否支援在資料地圖搜尋頁作為篩選條件，預設為 false，目前僅 ENUM 類型設定該值為 true。

    false
    Comment

    string

    否

    自訂屬性描述，長度小於 256 個字元。

    test comment

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

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

    boolean

    請求是否成功。

    true
    Result

    boolean

    建立結果。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。