All Products
Search

This Product

    DataWorks:UpdateColumnBusinessMetadata

    Document Center

    DataWorks:UpdateColumnBusinessMetadata

    Last Updated:Jun 04, 2026

    Updates the business metadata for a column in a data map. This operation can only update the business description and custom attributes.

    Operation description

    1. This operation requires DataWorks Basic Edition or a later version.

    2. This operation supports only MaxCompute, hms, and dlf tables.

    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 parameters

    Parameter

    Type

    Required

    Description

    Example
    Id

    string

    Yes

    The ID of the column. You can obtain this ID from the response of the ListColumns operation. For more information, see Metadata Entity Concepts.

    maxcompute-column:::project_name:[schema_name]:table_name:column_name
    Description

    string

    No

    The business description of the column.

    test description
    CustomAttributes

    object

    No

    The custom attributes of the column, specified as key-value pairs. The key is the attribute identifier, and the value is an array that can contain at most one element. An empty array deletes the attribute's value. To avoid overwriting the column's business description, omit the Description parameter from the request. An empty object ({}) indicates that no custom attributes are updated.

    {"biz_owner":["张三"]}

    array

    No

    An array that contains the custom attribute value. This array can contain at most one element.

    string

    No

    The attribute value.

    张三

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned data.

    RequestId

    string

    The request ID.

    D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
    Success

    boolean

    Indicates whether the request was successful.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.