统一目录实体修改¶

POST /api/v1/unified_catalog/entity/modify

概述¶

修改统一目录实体。

Body 请求参数¶

参数名	类型	必选	说明
urn	string		实体 URN，建议传入以精确定位修改对象允许为空: False
entityType	string	Y	实体类型编码允许为空: False
name	string	Y	实体名称允许为空: False
attributes	json		实体属性对象允许为空: False
telemetrySelectors	array		关联查询信息配置允许为空: False

参数补充说明¶

请求参数说明

参数名	type	必选	说明
urn	string	否	实体 URN，建议传入以精确定位实体
entityType	string	是	实体类型编码
name	string	是	实体名称
attributes	json	否	需要更新的实体属性对象
telemetrySelectors	array	否	需要更新的实体关联查询配置

关系字段使用说明

attributes.depends_on 会写入为 links。
attributes.component_of 会写入为 contains。
若要清空关系，请显式传空数组，例如 {"component_of":[]}。

调用注意事项

推荐同时传 urn、entityType、name。
修改成功后返回目标实体的 urn。
标签字段若传入新标签名，也会自动创建对应标签。

请求例子¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:mysql:default:demo","entityType":"database","name":"demo","attributes":{"project":"demo","env":"test","component_of":[]}}'

响应¶

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}