getTableSchemaByVersion

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

스키마 버전을 지정하여 테이블 스키마를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`catalogId`	Integer	Required	카탈로그 아이디 getCatalogs 참조
`databaseName`	String	Required	데이터베이스 이름 getDatabases 참조
`tableName`	String	Required	테이블 이름 getTables 참조
`version`	Integer	Required	스키마 버전 getTableSchemaVersions 참조

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`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/log_database/tables/log_table_1/schema/4?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 형식
`schema`	Array	-	스키마 정보

`schema`

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

필드	타입	필수 여부	설명
`name`	String	-	필드 이름
`type`	String	-	데이터 형식
`typeValue`	String	-	데이터 형식의 제약 사항 값이 존재하는 경우, 표시 `type`이 `array`인 경우, 하위 필드 표시
`description`	String	-	필드 설명 값이 존재하는 경우, 표시

응답 상태 코드

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

응답 예시

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 1,
    "requestId": "b8c9758d-****-****-****-ba467e88fff9",
    "schema": [
        {
            "name": "array",
            "type": "array",
            "typeValue": "array<struct<log_id:bigint,timestamp:string,level:string,message:string,source:string>>",
            "description": "raw data"
        }
    ]
}