VPC 환경에서 이용 가능합니다.
카탈로그 내 데이터베이스 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/catalogs/{catalogId}/databases |
요청 헤더
Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 Data Catalog 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
catalogId |
Integer | Required | 카탈로그 아이디
|
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
pageNo |
Integer | Optional | 페이지 번호
|
pageSize |
Integer | Optional | 페이지 출력 수
|
searchValue |
String | Optional | 검색 키워드
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases?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}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
pageNo |
Integer | - | 페이지 번호 |
pageSize |
Integer | - | 페이지 출력 수 |
totalCount |
Integer | - | 응답 결과 수 |
requestId |
String | - | 요청에 대한 아이디
|
databaseResponseList |
Array | - | 데이터베이스 목록 |
databaseResponseList
databaseResponseList
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
catalogId |
Integer | - | 카탈로그 아이디 |
name |
String | - | 데이터베이스 이름 |
description |
String | - | 데이터베이스 설명 |
createTime |
String | - | 데이터베이스 생성 일시
|
응답 상태 코드
Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Catalog 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"pageNo": 1,
"pageSize": 20,
"totalCount": 2,
"requestId": "aff80286-****-****-****-6ac1d306b14a",
"databaseResponseList": [
{
"catalogId": 4**,
"name": "my_database",
"description": "my database",
"createTime": "2025-03-17T16:30:08+0900"
},
{
"catalogId": 4**,
"name": "default",
"description": "Default Data Catalog database for test",
"createTime": "2025-03-17T14:30:26+0900"
}
]
}