统一目录实体字段值数量统计¶

POST /api/v1/unified_catalog/entity/field_value/count

概述¶

统计指定字段在当前查询范围内各个取值对应的实体数量，并返回命中的实体总数。

Body 请求参数¶

参数名	类型	必选	说明
fieldList	array	Y	需要统计的字段列表，支持实体基础字段和 attributes 字段允许为空: False 例子: ['entityType', 'provider', 'attributes.env']
urn	string		按实体 URN 精确过滤允许为空: False
entityType	string		实体类型编码允许为空: False
provider	string		单个来源类型允许为空: False
providers	array		来源类型列表允许为空: False
search	string		搜索关键词，匹配 urn / name / display_name 允许为空: False
filters	json		attributes 字段过滤允许为空: False

参数补充说明¶

请求参数说明

参数名	type	必选	说明
fieldList	array[string]	是	需要统计的字段列表
urn	string	否	按实体 URN 精确过滤
entityType	string	否	实体类型过滤
provider	string	否	单个来源类型
providers	array[string]	否	多个来源类型列表
search	string	否	模糊搜索条件
filters	json	否	`attributes` 字段过滤

fieldList 字段说明

支持实体基础字段，例如：entityType、provider、urn、name、displayName。
支持 attributes 字段，例如：env、project、attributes.env、attributes.project。
env 与 attributes.env 等价。

调用注意事项

返回中的 totalCount 表示当前过滤条件命中的实体总数，不受 fieldList 影响。
数组类型属性会拆成多个值分别统计。

请求例子¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/field_value/count' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"fieldList":["entityType","provider","attributes.env"],"providers":["discovery"]}'

响应¶

{
    "code": 200,
    "content": {
        "totalCount": 1562,
        "items": [
            {
                "field": "entityType",
                "values": [
                    {
                        "value": "cloud_resource",
                        "count": 1435
                    },
                    {
                        "value": "service",
                        "count": 52
                    }
                ]
            },
            {
                "field": "env",
                "values": [
                    {
                        "value": "prod",
                        "count": 20
                    }
                ]
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}