Obtaining the Database List
Function
This API is used to obtain the database list.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/{connection_id}/databases
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
| connection_id | Yes | String | Data connection ID, which can be obtained from the data connection list. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | String | Maximum number of data records |
| offset | No | String | Offset |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. This parameter is mandatory for token authentication. Call the "Obtaining the User Token" API of IAM to obtain the value of X-Subject-Token in the response header. |
| workspace | Yes | String | Workspace ID |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_count | Integer | Number of databases connected to the current data connection |
| dw_id | String | Data connection ID. |
| databases | Array of DatabasesList objects | Database list |
| Parameter | Type | Description |
|---|---|---|
| database_name | String | Database name |
| description | String | Database description |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Returned error information. |
| error_code | String | Returned error code. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Returned error information. |
| error_code | String | Returned error code. |
Example Requests
None
Example Responses
Status code: 200
The database list is returned.
{
"dw_id" : "f6ce0c0de8f14ba8b7fbf23486b8ec16",
"databases" : [ {
"database_name" : "dlcatalog_2fe5",
"description" : null
}, {
"database_name" : "dlcatalog_3e24",
"description" : null
}, {
"database_name" : "dlcatalog_677a",
"description" : null
}, {
"database_name" : "dlcatalog_86e4",
"description" : null
}, {
"database_name" : "dlcatalog_ced5",
"description" : null
} ],
"total_count" : 21
} Status code: 400
Bad request.
{
"error_code" : "DAYU.4402",
"error_msg" : "The operation failed, detail msg {0}."
} Status code: 500
Internal server error.
{
"error_code" : "DAYU.3531",
"error_msg" : "Internal server error: {0}"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The database list is returned. |
| 400 | Bad request. |
| 500 | Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
