getDatabases
- Print
- PDF
getDatabases
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Searches for all databases in the user’s catalog.
Requests
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| pageNo | No | int | Page number Default: 1 | |
| pageSize | No | int | Maximum: 200 | Size of result list Default: 20 |
| searchValue | No | String | Search word for the name of the database |
Request header
Request examples
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases?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}"
Responses
Response bodies
- databaseResponseList: database list of the user’s catalog
| Item | Type | Description |
|---|---|---|
| catalogId | Int | Unique catalog ID |
| name | String | Database name |
| description | String | Database description |
| createTime | Date | Database creation date and time |
Response examples
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"pageNo": 1,
"pageSize": 20,
"totalCount": 1,
"requestId": "7cf2c366-986e-461a-afae-4cc081c153dd",
"databaseResponseList": [
{
"catalogId": 2144,
"name": "default",
"description": "Default Data Catalog database1",
"createTime": "2023-02-21T15:35:30+0900"
}
]
}
Was this article helpful?