All Products
Search
Document Center

DataWorks:UpdateColumnBusinessMetadata

更新時間:Dec 10, 2025

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
IdstringYes

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:11075xxxx::test_project:test_schema:test_table:test_column
DescriptionstringNo

The field business description.

test description

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The request ID.

D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.