UpdateCustomAttribute-阿里云帮助中心

Updates a custom attribute.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:UpdateCustomAttribute

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The custom attribute ID.	custom-attribute:biz_owner
DisplayName	string	No	The new display name for the custom attribute. It must be less than 128 characters.	Business owner
EntityTypes	array	No	The applicable entity types. This parameter supports specific types and wildcard formats, such as `-table` and `-column`. For example: `dataworks-project`: A DataWorks workspace `dataworks-dataset`: A DataWorks dataset `maxcompute-table`: A MaxCompute table `*-column`: All column types
	string	No	The entity type.	maxcompute-table
ValueEnums	array	No	The enumerated values. This applies only to custom attributes of the `enum` type. You can only append new values during an update.
	string	No	A value for the enum.	VALUE_1
DisplayEnabled	boolean	No	Whether to display the custom attribute in the UI.	true
SearchFilterEnabled	boolean	No	Whether the custom attribute can be used as a filter condition.	false
Comment	string	No	The new description for the custom attribute. It must be less than 256 characters.	test comment

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	6B56C4A2-C7F3-52AF-8417-6DFF7447011B
Success	boolean	Whether the request was successful.	true
Result	boolean	Whether the update operation was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "6B56C4A2-C7F3-52AF-8417-6DFF7447011B",
  "Success": true,
  "Result": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.