콘텐츠로 이동

통합 카탈로그 토폴로지 필터 옵션¶

POST /api/v1/unified_catalog/topology/filter_options

개요¶

지정된 필드의 필터링 가능한 값 목록을 가져옵니다.

본문 요청 매개변수¶

매개변수명	유형	필수	설명
entityType	string		엔터티 유형 코드 Null 허용: False
fields	array	Y	필터 옵션을 반환해야 하는 필드 목록, 최대 64개 Null 허용: False 예시: ['project', 'owner'] $minLength: 1 최대 길이: 64
filters	json		선택된 필터 조건 Null 허용: False
search	string		후보 값 검색의 호환 매개변수, 신규 호출자는 fieldValue 사용을 권장 Null 허용: False
fieldValue	string		후보 값만 필터링; search와 동시 전송 시 우선 사용 Null 허용: False

매개변수 추가 설명¶

요청 매개변수 설명

매개변수명	type	필수	설명
entityType	string	아니오	엔터티 유형 코드; 상태 필드 필터 옵션 요청 또는 상태 필드로 필터링 시 필수
fields	array[string]	예	필터 옵션을 반환해야 하는 필드 목록, 최대 64개
filters	json	아니오	선택된 필터 조건
search	string	아니오	후보 값 검색의 호환 매개변수, 신규 호출자는 fieldValue 사용을 권장
fieldValue	string	아니오	후보 값만 필터링; `search`와 동시 전송 시 우선 사용

호출 참고 사항

fields는 여러 필드 전송을 지원하며, 인터페이스는 각 필드의 선택 가능한 값을 각각 반환합니다.
필드가 owner인 경우, 반환 결과는 가능한 한 팀이 읽을 수 있는 이름으로 해석됩니다.
filters는 연동 필터링 시나리오에 사용할 수 있습니다.
fields 또는 filters에 상태 필드가 포함된 경우 entityType은 필수입니다. 유형이 비활성화된 경우 유효한 비활성화 상태에 따라 후보 값이 생성됩니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/topology/filter_options' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"fields":["project","owner"],"entityType":"service"}'

응답¶

{
    "code": 200,
    "content": {
        "project": [
            {
                "label": "demo",
                "value": "demo"
            }
        ],
        "owner": [
            {
                "label": "研发团队",
                "value": "研发团队"
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}