All Products
Search

This Product

    DataWorks:UpdateColumnBusinessMetadata

    Document Center

    DataWorks:UpdateColumnBusinessMetadata

    Last Updated:Mar 30, 2026

    Updates the business metadata of a column in a table in Data Map. Only the business description of a column can be updated.

    Operation description

    1. DataWorks Basic Edition or a higher edition is required.

    2. Only the maxcompute, hms, and dlf types are supported.

    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 field ID. You can refer to the response from the ListColumns operation. You can also refer to the Concepts related to metadata entities.

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

    string

    No

    The field business description.

    test description

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    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.