getDatabase
- Print
- PDF
getDatabase
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Searches for a specific database with the database name of the user's catalog.
Requests
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| databaseName | Yes | String | Database name | |
| includeTags | Yes | Boolean | Inclusion status of the tag information in the response value |
Request header
Request examples
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}"
Responses
Response bodies
| Item | Type | Description |
|---|---|---|
| catalogId | Int | Unique catalog ID |
| name | String | Database name |
| databaseName | String | Database name |
| description | String | Database description |
| location | String | Database location |
| tagKeyTypeValueList[].tagKey | String | Key of the tag |
| tagKeyTypeValueList[].tagType | String | Type of the tag |
| tagKeyTypeValueList[].tagValue | String | Value of the tag |
| tagKeyTypeValueList[].tagTemplateTagId | Int | Unique tag ID |
| createTime | Date | Database creation date and time |
| updateTime | Date | Database modification date and time |
Response examples
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"
}
Was this article helpful?