getCatalogs

VPC 환경에서 이용 가능합니다.

카탈로그 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/catalogs

요청 헤더

Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 Data Catalog 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~200 (기본값: 20)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs?pageNo=1&pageSize=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`catalogId`	Integer	-	카탈로그 아이디
`catalogStatus`	String	-	카탈로그 상태 `CREATED` \| `DELETED` `CREATED`: 생성됨 `DELETED`: 삭제됨
`metastoreStatus`	String	-	카탈로그 메타스토어 상태 `METASTORE_STARTING` \| `METASTORE_RUNNING` \| `METASTORE_CONFIGURING` \| `METASTORE_STOPPING` \| `METASTORE_STOPPED` \| `METASTORE_FAILED_START` `METASTORE_STARTING`: 시작 중 `METASTORE_RUNNING`: 정상 `METASTORE_CONFIGURING`: 재설정 중 `METASTORE_STOPPING`: 정지 중 `METASTORE_STOPPED`: 정지 `METASTORE_FAILED_START`: 시작 실패
`createTime`	String	-	카탈로그 생성 일시 ISO 8601 형식
`updateTime`	String	-	업데이트 일시 ISO 8601 형식

응답 상태 코드

Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Catalog 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

[
    {
        "catalogId": 4**,
        "catalogStatus": "CREATED",
        "metastoreStatus": "METASTORE_RUNNING",
        "createTime": "2025-03-17T14:29:52+0900",
        "updateTime": "2025-03-17T14:30:40+0900"
    }
]