getTablesByDatabase

Prev Next

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

데이터베이스 내 테이블 목록을 조회합니다.

요청

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

메서드 URI
GET /api/v1/catalogs/{catalogId}/databases/{databaseName}/tables

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
catalogId Integer Required 카탈로그 아이디
databaseName String Required 데이터베이스 이름

요청 쿼리 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/my_database/tables?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 - 요청에 대한 아이디
  • UUID 형식
tableResponseList Array - 테이블 목록

tableResponseList

tableResponseList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
catalogId Integer - 카탈로그 아이디
tableName String - 테이블 이름
databaseName String - 데이터베이스 이름
location String - 테이블 위치
dataFormat String - 데이터 형식
createTime String - 테이블 생성 일시
  • ISO 8601 형식
updateTime String - 업데이트 일시
  • ISO 8601 형식

응답 상태 코드

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

응답 예시

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 2,
    "requestId": "570aad8d-****-****-****-898f3c1bd0d6",
    "tableResponseList": [
        {
            "catalogId": 4**,
            "tableName": "employeelist",
            "databaseName": "my_database",
            "location": "s3a://datacatalog-c***-e******f/my_database/employeeList",
            "dataFormat": "csv",
            "createTime": "2025-03-18T09:31:32+0900",
            "updateTime": "2025-03-18T09:52:11+0900"
        },
        {
            "catalogId": 4**,
            "tableName": "db_metadata_json",
            "databaseName": "my_database",
            "location": "s3a://datacatalog-c***-e******f/db_metadata.json",
            "dataFormat": "json",
            "createTime": "2025-03-17T16:30:43+0900",
            "updateTime": "2025-03-18T10:12:18+0900"
        }
    ]
}