全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListCustomAttributes - 查询自定义属性列表

更新时间:Jun 05, 2026

查询自定义属性定义列表

调试

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

调试

授权信息

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

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页页码,默认为 1

1

PageSize

integer

分页大小,默认为 10,最大 100

10

DisplayName

string

自定义属性展示名称,按普通文本包含匹配

Owner

EntityTypes

string

自定义属性适用的实体类型,多个实体类型使用英文逗号分隔,例如 *-table,*-column。支持具体实体类型(如 hms-table、emr-table)以及通配类型 *-table*-column

maxcompute-table

Comment

string

自定义属性描述,模糊匹配

owner

SortBy

string

排序字段,支持 CreateTime、ModifyTime

枚举值:

  • ModifyTime :

    ModifyTime

  • CreateTime :

    CreateTime

CreateTime

Order

string

排序方向,支持 Asc、Desc

Asc

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

RequestId

54594ACA-7976-5273-958B-02E15E9B867C

Success

boolean

请求是否成功

true

PagingInfo

object

分页信息

TotalCount

integer

总数

10

PageNumber

integer

分页页码

1

PageSize

integer

分页大小

10

CustomAttributes

array

自定义属性对象列表

CustomAttribute

自定义属性对象

示例

正常返回示例

JSON格式

{
  "RequestId": "54594ACA-7976-5273-958B-02E15E9B867C",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "CustomAttributes": [
      {
        "Id": "custom-attribute:biz_owner",
        "DisplayName": "业务负责人",
        "Type": "TEXT",
        "EntityTypes": [
          "maxcompute-table"
        ],
        "ValueEnums": [
          "VALUE_1"
        ],
        "SearchFilterEnabled": false,
        "DisplayEnabled": true,
        "Comment": "this is a comment",
        "CreateTime": 1750817692000,
        "ModifyTime": 1763380628000
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情