getDatabase
- 인쇄
- PDF
getDatabase
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
사용자 catalog의 database 이름으로 특정 database를 조회합니다.
요청
요청 URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| catalogId | Yes | String | catalog 고유 id (ref: getCatalogs) | |
| databaseName | Yes | String | database 이름 | |
| includeTags | Yes | Boolean | 응답값에 tag 정보 포함 여부 |
요청 헤더
요청 예시
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}?includeTags=true" \
-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}"
응답
응답 바디
| 항목 | 타입 | 설명 |
|---|---|---|
| catalogId | Int | catalog 고유 id |
| name | String | database 이름 |
| databaseName | String | database 이름 |
| description | String | database 설명 |
| location | String | database 위치 |
| tagKeyTypeValueList[].tagKey | String | tag의 key |
| tagKeyTypeValueList[].tagType | String | tag의 type |
| tagKeyTypeValueList[].tagValue | String | tag의 value |
| tagKeyTypeValueList[].tagTemplateTagId | Int | tag 고유 id |
| createTime | Date | database 생성 일시 |
| updateTime | Date | database 수정 일시 |
응답 예시
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"catalogId": 2144,
"name": "default",
"databaseName": "default",
"description": "Default Data Catalog database1",
"location": "s3a://datacatalog-c2144-a0211690/default",
"tagKeyTypeValueList": [
{
"tagKey": "key",
"tagType": "STRING",
"tagValue": "value",
"tagTemplateTagId": 0
}
],
"createTime": "2023-02-21T15:35:09+0900",
"updateTime": "2023-02-21T16:22:00+0900"
}
이 문서가 도움이 되었습니까?