UpdateCustomAttribute

更新时间:
复制 MD 格式

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

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

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 128 characters or less.

业务负责人

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 256 characters or less.

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.