getTable

Prev Next

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

테이블의 상세 정보를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/my_database/tables/employeelist' \
--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 - 카탈로그 아이디
databaseName String - 데이터베이스 이름
tableName String - 테이블 이름
dataFormat String - 데이터 형식
location String - 테이블 위치
description String - 테이블 설명
createTime String - 테이블 생성 일시
  • ISO 8601 형식
updateTime String - 업데이트 일시
  • ISO 8601 형식
properties Object - 테이블 속성 정보
properties.EXTERNAL String - 테이블의 외부 저장 여부
  • TRUE | FALSE
    • TRUE: 외부 저장
    • FALSE: 내부 저장
properties.compressionType String - 압축 파일 확장자
  • 스캔 대상이 압축 파일인 경우, 표시
properties.clusterNo String - DB 서비스 번호
  • 스캔 대상이 데이터베이스인 경우, 표시
properties.connectionId String - 커넥션 아이디
  • 커넥션이 존재하는 경우, 표시
properties.connectionName String - 커넥션 이름
  • 커넥션이 존재하는 경우, 표시
properties.created_time String - 테이블 생성 일시
  • Unix Timestamp 형식
properties.dataFormat String - 데이터 형식
properties.dataType String - 데이터 유형
properties.delimiter String - 구분 기호
  • 데이터가 CSV 파일인 경우, 표시
properties.inputFormat String - 데이터 읽기 포맷
properties.isDirectory String - 스캔 대상의 디렉터리 여부
  • TRUE | FALSE
    • TRUE: 디렉터리
    • FALSE: 디렉터리 아님
properties.last_modified_time String - 업데이트 일시
  • Unix Timestamp 형식
properties.metadata_location String - 메타데이터 파일 경로
  • Iceberg 테이블인 경우, 표시
properties.numFiles String - 스캔한 총 파일 수
  • 스캔 대상이 디렉터리인 경우, 표시
properties.objectstorageContentLength String - 객체 길이(Byte)
properties.objectstorageContentType String - 객체 데이터 타입
properties.objectstorageLastModified String - 객체 업데이트 일시
  • Unix Timestamp 형식
properties.outputFormat String - 데이터 출력 포맷
properties.partitioningScheme String - 파티셔닝 스키마
  • 스캔 대상에 파티션이 인식된 경우, 표시
properties.scannerId String - 스캐너 아이디
properties.scannerName String - 스캐너 이름
properties.serializationLib String - 직렬화 및 역직렬화 라이브러리
properties.skip.header.line.count String - 제외한 헤더 라인 수
properties.totalSize String - 스캔 데이터 총량(Byte)
  • 스캔 대상이 디렉터리인 경우, 표시
properties.transient_lastDdlTime String - 테이블 DDL 업데이트 일시
  • Unix Timestamp 형식
properties.serde.escapeChar String - 데이터 인식 제거 문자
  • 데이터가 CSV 파일인 경우, 표시
properties.serde.quoteChar String - 데이터 인식 기호
  • 데이터가 CSV 파일인 경우, 표시
properties.serde.separatorChar String - 스키마 결정 구분 기호
  • 데이터가 CSV 파일인 경우, 표시
참고

테이블 유형에 따라 표시되는 속성 정보가 달라질 수 있습니다.

  • Apache Iceberg 테이블의 속성 정보에 대한 자세한 내용은 Iceberg Table Metadata를 참조해 주십시오.

RDB 데이터인 경우

RDB(MySQL, MSSQL, PostgreSQL) 데이터인 경우, 추가로 표시되는 속성에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
properties.{dbType}Collation String - 문자열 정렬 설정
properties.{dbType}DataSize String - 데이터 크기
properties.{dbType}IndexSize String - 인덱스 크기
properties.{dbType}Indexes String - 인덱스 구조
properties.{dbType}Rows String - 행(레코드) 수
properties.{dbType}TableSize String - 테이블 전체 크기

MongoDB 데이터인 경우

MongoDB 데이터인 경우, 추가로 표시되는 속성에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
properties.mongodbAvgObjSize String - 컬렉션 평균 객체 크기
properties.mongodbFreeStorageSize String - 컬렉션 여유 저장 용량
properties.mongodbIndexSize String - 컬렉션 인덱스 크기
properties.mongodbIndexes String - 컬렉션 인덱스 정보
properties.mongodbRowCount String - 컬렉션 행(레코드) 수
properties.mongodbSize String - 컬렉션 크기
  • 압축되지 않은 크기
  • 인덱스 크기 제외
properties.mongodbStorageSize String - 컬렉션에 할당된 스토리지 크기
properties.mongodbTotalSize String - 컬렉션 전체 디스크 용량

응답 상태 코드

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

응답 예시

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

{
    "catalogId": 4**,
    "databaseName": "default",
    "tableName": "employeelist",
    "dataFormat": "csv",
    "location": "s3a://datacatalog-c***-e******f/my_database/employeeList/",
    "createTime": "2025-03-18T09:34:52+0900",
    "updateTime": "2025-03-18T09:42:28+0900",
    "properties": {
        "EXTERNAL": "TRUE",
        "compressionType": "",
        "created_time": "1742258092",
        "dataFormat": "csv",
        "dataType": "file",
        "inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
        "isDirectory": "TRUE",
        "last_modified_time": "1742258548",
        "numFiles": "1",
        "objectstorageContentLength": "5095",
        "objectstorageContentType": "text/csv",
        "objectstorageLastModified": "1742257929",
        "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
        "scannerId": "9**",
        "scannerName": "employee_list",
        "serializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
        "skip.header.line.count": "1",
        "totalSize": "5095",
        "transient_lastDdlTime": "1742258092",
        "serde.escapeChar": "\\",
        "serde.quoteChar": "\"",
        "serde.separatorChar": ","
    }
}