콘텐츠로 이동

통합 카탈로그 엔터티 필드 값 개수 통계¶

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

개요¶

지정된 필드에 대해 현재 쿼리 범위 내에서 각 값에 해당하는 엔터티 개수를 통계하고, 일치하는 엔터티 총 개수를 반환합니다.

Body 요청 매개변수¶

매개변수명	유형	필수	설명
fieldList	array	Y	통계할 필드 목록, 최대 64개 항목; 엔터티 기본 필드 및 attributes 필드 지원 빈 값 허용: False $minLength: 1 최대 길이: 64 예시: ['entityType', 'provider', 'attributes.env']
urn	string		엔터티 URN으로 정확히 필터링 빈 값 허용: False
entityType	string		엔터티 유형 코드 빈 값 허용: False
provider	string		단일 소스 유형 빈 값 허용: False
providers	array		소스 유형 목록 빈 값 허용: False
search	string		검색 키워드, urn / name / display_name 일치 빈 값 허용: False
fieldValue	string		후보 버킷만 필터링; search와 함께 사용 가능, search가 먼저 전체 엔터티를 필터링하고 fieldValue가 후보 값을 필터링 빈 값 허용: False
filters	json		attributes 필드 필터링 빈 값 허용: False

매개변수 추가 설명¶

요청 매개변수 설명

매개변수명	type	필수	설명
fieldList	array[string]	예	통계할 필드 목록, 최대 64개 항목
urn	string	아니요	엔터티 URN으로 정확히 필터링
entityType	string	아니요	엔터티 유형 필터링
provider	string	아니요	단일 소스 유형
providers	array[string]	아니요	여러 소스 유형 목록
search	string	아니요	퍼지 검색 조건
fieldValue	string	아니요	후보 버킷만 필터링; `search`와 함께 사용 가능, 두 조건은 각각 전체 엔터티 집합과 후보 값에 적용됨
filters	json	아니요	`attributes` 필드 필터링

fieldList 필드 설명

엔터티 기본 필드 지원(예: entityType, provider, urn, name, displayName).
attributes 필드 지원(예: env, project, attributes.env, attributes.project).
env는 attributes.env와 동일합니다.

호출 시 주의사항

응답 내 totalCount는 현재 필터 조건에 일치하는 엔터티 총 개수를 나타내며, fieldList의 영향을 받지 않습니다.
배열 유형 속성은 여러 값으로 분할되어 각각 통계됩니다.
fieldList 또는 filters에 상태 필드가 포함된 경우 반드시 entityType을 전달해야 합니다. 유형이 비활성화된 경우 unknown/null 유효 비활성화 상태로 통계하며, 이전 상태 값을 읽지 않습니다.

요청 예시¶

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"
}