CreateCustomAttribute - 创建自定义属性

更新时间:
复制 MD 格式

创建自定义属性定义

调试

您可以在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
}

错误码

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

变更历史

更多信息,参考变更详情