GetCustomAttribute-阿里云帮助中心

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
Id	string	Yes	The custom attribute ID. The ID must match the regular expression `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. The part after 'custom-attribute:' must be less than 100 characters long.	custom-attribute:biz_owner

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	BA51C9E6-0CBC-5BB9-92BD-0C4FE66E1717
Success	boolean	Indicates whether the request was successful.	true
CustomAttribute	CustomAttribute	The custom attribute definition.

Examples

Success response

JSON format

{
  "RequestId": "BA51C9E6-0CBC-5BB9-92BD-0C4FE66E1717",
  "Success": true,
  "CustomAttribute": {
    "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
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.