통합 카탈로그 엔터티 내보내기¶
GET /api/v1/unified_catalog/entity/export
개요¶
통합 카탈로그 엔터티 목록을 CSV로 내보냅니다. 내보내기 열은 엔터티 유형 뷰 정의 viewDefine.layout을 기준으로 합니다.
Query 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| entityType | string | Y | 엔터티 유형 코드 비어 있음 허용: False |
| provider | string | 단일 소스 유형, 여러 값은 filters 또는 providers 시나리오 인터페이스 사용 권장 비어 있음 허용: False |
|
| search | string | 퍼지 검색, urn / display_name / name 매칭 비어 있음 허용: False |
|
| filters | json | attributes 필드 필터, JSON 객체 또는 문자열화된 JSON 지원 비어 있음 허용: False 예시: {'env': ['prod']} |
|
| orderBy | string | 정렬 필드, 기본값 updatedAt 비어 있음 허용: False |
|
| order | string | 정렬 방식, 기본값 desc 비어 있음 허용: False |
매개변수 추가 설명¶
요청 매개변수 설명
| 매개변수명 | type | 필수 | 설명 |
|---|---|---|---|
| entityType | string | 예 | 엔터티 유형 코드, 유형에 따라 내보내기 열이 다름 |
| provider | string | 아니요 | 단일 소스 유형 |
| search | string | 아니요 | 퍼지 검색, urn / display_name / name 매칭 |
| filters | json | 아니요 | attributes 필드 필터 |
| orderBy | string | 아니요 | 정렬 필드, 기본값 updatedAt |
| order | string | 아니요 | 정렬 방향, 기본값 desc |
호출 시 주의사항
- 내보내기 열은 엔터티 유형 뷰 정의
viewDefine.layout을 기준으로 합니다. filters는 JSON 객체 또는 문자열화된 JSON을 지원합니다.- API 호출 성공 시 CSV 파일 스트림이 직접 반환되므로, 호출자는 파일 다운로드 방식으로 처리하는 것을 권장합니다.
요청 예시¶
curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/export?entityType=database&filters={"env":["prod"]}' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--output entities.csv