getTableSchema
- 인쇄
- PDF
getTableSchema
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
사용자 catalog의 database/table 이름으로 특정 table의 schema를 조회합니다.
요청
요청 URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}/schema
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| catalogId | Yes | String | catalog 고유 id (ref: getCatalogs) | |
| databaseName | Yes | String | database 이름 | |
| tableName | Yes | String | table 이름 | |
| pageNo | No | int | 페이지 번호기본값: 1 | |
| pageSize | No | int | 최대값: 200 | 결과 목록 크기기본값: 20 |
요청 헤더
요청 예시
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}/schema?pageNo=1&pageSize=20" \
-H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
-H "x-ncp-iam-access-key: {x-ncp-iam-access-key}" \
-H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
응답
응답 바디
| 항목 | 타입 | 설명 |
|---|---|---|
| schema.name | String | 필드 이름 |
| schema.type | String | 데이터 유형 |
| schema.description | String | 설명 |
응답 예시
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"pageNo": 1,
"pageSize": 20,
"totalCount": 2,
"requestId": "e69042d1-8b84-4bdc-902f-95b4dd8f0b88",
"schema": [
{
"name": "id",
"type": "int",
"description":"string"
},
{
"name": "test",
"type": "string",
"description":"string"
}
]
}
이 문서가 도움이 되었습니까?