ListCustomAttributes - ListCustomAttributes-阿里云帮助中心

Retrieves a list of custom attribute definitions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
DisplayName	string	No	The display name of the custom attribute. Plain text substring matching is used.	Owner
EntityTypes	string	No	The entity types to which the custom attribute applies. Separate multiple entity types with commas (,), such as `-table,-column`. Specific entity types (such as hms-table and emr-table) and wildcard types `-table` and `-column` are supported.	maxcompute-table
Comment	string	No	The description of the custom attribute. Fuzzy matching is used.	owner
SortBy	string	No	The field used for sorting. Valid values: CreateTime and ModifyTime. Valid values: ModifyTime : ModifyTime CreateTime : CreateTime	CreateTime
Order	string	No	The sort order. Valid values: Asc and Desc.	Asc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	RequestId	54594ACA-7976-5273-958B-02E15E9B867C
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
CustomAttributes	array	The list of custom attribute objects.
	CustomAttribute	The custom attribute object.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.