统一目录拓扑实体字段定义¶

GET /api/v1/unified_catalog/topology/entity_fields

概述¶

获取统一目录拓扑可用字段定义。

Query 请求参数¶

参数名	类型	必选	说明
entityType	string		实体类型编码；不传或传空时返回所有实体类型字段允许为空: True

参数补充说明¶

请求参数说明

参数名	type	必选	说明
entityType	string	否	实体类型编码

调用注意事项

entityType 不传或传空字符串时，返回当前工作空间下所有实体类型字段。
若只需要某一类实体的字段定义，建议传入对应 entityType 缩小返回范围。

请求例子¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/topology/entity_fields?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

响应¶

{
    "code": 200,
    "content": {
        "items": [
            {
                "field": "project",
                "title": "项目",
                "entityTypes": [
                    "service",
                    "database"
                ]
            },
            {
                "field": "env",
                "title": "环境",
                "entityTypes": [
                    "service"
                ]
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}