全部产品
Search
文档中心

大数据开发治理平台 DataWorks:CreateCustomAttribute - 创建自定义属性

更新时间:Jun 05, 2026

创建自定义属性定义。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

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

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 of the request

5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71

Success

boolean

请求是否成功

true

Result

boolean

创建结果

true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情