UpdateColumnBusinessMetadata - Update business metadata for a column in a Data Map table
Updates business metadata for a specified column in Data Map. Only the business description and custom attributes can be updated.
Operation description
-
This operation requires DataWorks Basic Edition or a later version.
-
This operation supports only MaxCompute, hms, and dlf tables.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
string |
Yes |
The column ID. You can obtain the ID from the response of the ListColumns operation. For more information, see Concepts of metadata entities. |
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 attribute values. The key is the identifier of a custom attribute, and the value contains at most one element. An empty list clears the attribute value. If you do not specify the Description parameter, specify this parameter to avoid clearing the business description of the column. An empty object leaves custom attributes unchanged. |
{"biz_owner":["John"]} |
|
array |
No |
The array of custom attribute values. Currently, only single-value arrays are supported. |
||
|
string |
No |
The attribute value. |
John |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx |
| Success |
boolean |
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.