Description
You can call this operation to query databases.
Call description
Prerequisites
You have passed the authentication for the OCP application service.
You have the Read-only permission on the specified tenant.
Request path
GET /api/v2/ob/clusters/{id}/tenants/{tenantId}/databases
Request parameters
Path parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Integer | Yes | 1 | The ID of the cluster. |
| tenantId | Integer | Yes | 5 | The ID of the tenant. |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| data | Object | The data returned by the request, including the contents parameter. |
| ├─ contents | Array | The list of databases. For more information about the data structure, see the following table. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the server that responded to the request. |
Data structure of the database information
Parameter |
Type |
Description |
|---|---|---|
| dbName | String | The name of the database. |
| charset | String | The character set. |
| collation | String | The collation. |
| primaryZone | String | The priorities of the zones. |
| readonly | Boolean | Indicates whether the database was read-only. |
| createTime | Datetime | The creation time. |
| connectionUrls | Array | The list of OBProxies and connection strings. |
| ├─ connectionStringType | String | The type of the connection string. Valid values: * OBPROXY * DIRECT |
| ├─ obProxyAddress | String | The IP address of the OBProxy. This parameter is valid only when the type of the connection string is OBPROXY. |
| ├─ obProxyPort | Integer | The port number of the OBProxy. This parameter is valid only when the type of the connection string is OBPROXY. |
| ├─ connectionString | String | The connection string. |
| requiredSize | Integer | The required size of the database. |
| id | Integer | The ID of the database. |
Examples
Sample request
Query databases in Tenant 1000001 of Cluster 1.
GET /api/v2/ob/clusters/1/tenants/1000001/databases?id=1&tenantId=1000001
Sample response
{
"data": {
"contents": [
{
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"connectionUrls": [
{
"connectionString": "jdbc:mysql://xxx.xxx.xxx.xxx:2881/oceanbase",
"type": "DIRECT"
}
],
"createTime": "2021-09-06T11:38:44.51598+08:00",
"dbName": "oceanbase",
"id": 1100611139403777,
"readonly": false
},
{
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"connectionUrls": [
{
"connectionString": "jdbc:mysql://xxx.xxx.xxx.xxx:2881/information_schema",
"type": "DIRECT"
}
],
"createTime": "2021-09-06T11:38:44.559335+08:00",
"dbName": "information_schema",
"id": 1100611139403778,
"readonly": false
},
{
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"connectionUrls": [
{
"connectionString": "jdbc:mysql://xxx.xxx.xxx.xxx:2881/mysql",
"type": "DIRECT"
}
],
"createTime": "2021-09-06T11:38:44.550886+08:00",
"dbName": "mysql",
"id": 1100611139403779,
"readonly": false
},
{
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"connectionUrls": [
{
"connectionString": "jdbc:mysql://xxx.xxx.xxx.xxx:2881/test",
"type": "DIRECT"
}
],
"createTime": "2021-09-06T11:38:44.567822+08:00",
"dbName": "test",
"id": 1100611139404776,
"readonly": false
}
]
},
"duration": 429,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-06T20:22:14.85+08:00",
"traceId": "58294ce0e07243a4"
}