UpdateTableBusinessMetadata
Updates the business metadata of a table in Data Map. Currently, only the table usage description and custom attributes can be updated.
Operation description
You must have DataWorks Basic Edition or a higher edition to use this feature.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
string |
Yes |
The ID of the table. For the format, refer to the response of the ListTables operation. |
maxcompute-table:::project_name:[schema_name]:table_name |
| Readme |
string |
No |
The usage description. Rich text format is supported. |
## introduction |
| CustomAttributes |
object |
No |
The custom attribute values. The key is the custom attribute identifier, and the value contains at most one element. An empty list indicates that the attribute value is deleted. Passing this parameter without Readme prevents the usage description from being cleared. An empty object indicates that custom attributes are not updated. |
{"biz_owner":["张三"]} |
|
array |
No |
The array of custom attribute values. Currently, only single-value arrays are supported. |
||
|
string |
No |
The attribute value. |
张三 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
7C352CB7-CD88-XXXXXXX |
| Success |
boolean |
Indicates whether the request was successful. |
true |
Examples
Success response
JSON format
{
"RequestId": "7C352CB7-CD88-XXXXXXX",
"Success": true
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.