跳转至

统一目录实体详情



POST /api/v1/unified_catalog/entity/get

概述

获取单个统一目录实体详情。

Body 请求参数

参数名 类型 必选 说明
urn string Y 实体 URN
允许为空: False
例子: urn:mysql:default:demo

参数补充说明

请求参数说明

参数名 type 必选 说明
urn string 目标实体的唯一 URN

返回结果说明

  • 返回实体基础信息、attributesteamInfotagsInfo
  • systemRelationInfo 为当前实体的一跳直接系统关系列表。

调用注意事项

  • systemRelationInfo 不做递归展开,只返回直接关系。
  • systemRelationInfo 中关系两端实体摘要的 attributes 为全量返回。

请求例子

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:mysql:default:demo"}'

响应

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo",
        "entityType": "database",
        "name": "demo",
        "attributes": {
            "project": "demo",
            "env": "prod"
        },
        "teamInfo": [],
        "tagsInfo": [],
        "systemRelationInfo": []
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
} 

文档评价

文档内容是否对您有帮助? ×