更新数据地图数据表给定字段的业务元数据,当前仅支持更新字段的业务描述和自定义属性。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
仅 maxcompute, hms, dlf 类型支持
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Id |
string |
是 |
字段 ID,可参考 ListColumns 接口返回结果, 以及元数据实体相关概念说明。 |
maxcompute-column:::project_name:[schema_name]:table_name:column_name |
| Description |
string |
否 |
字段业务描述。 |
test description |
| CustomAttributes |
object |
否 |
自定义属性值,key 为自定义属性标识,value 最多一个值;空列表表示删除该属性值。不传 Description 时传入本参数可避免清空字段业务描述;传空对象表示不更新自定义属性 |
{"biz_owner":["张三"]} |
|
array |
否 |
自定义属性值的数组,当前仅支持单值数组 |
||
|
string |
否 |
属性值 |
张三 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx |
| Success |
boolean |
请求是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。