Feature description
Adds a cluster that can be connected to the OceanBase cluster.
Call description
Interface constraints
The caller needs to be authenticated through the OCP application service.
Request path
POST /api/v2/obproxy/clusters/{id}/obLinks/batchAdd
Request parameters
path:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Long | Yes | 1 | The ID of the OBProxy cluster. |
body:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| obLinks | Array | Yes | - | Information about the OceanBase cluster that can be connected to. |
| ├─ clusterName | String | Yes | foo | The name of the OceanBase cluster. |
| ├─ obClusterId | Integer | Yes | 1 | The ID of the cluster on the OceanBase cluster. |
| ├─ username | String | Yes | proxyro | The username for connecting to the cluster. |
Return result
Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server finishes processing the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code that conforms to the HTTP status specification. |
| traceId | String | The Trace ID of the request, which is used to troubleshoot issues. |
| server | String | The address of the application service that responds to the request. |
Examples
Request example
POST /api/v2/obproxy/clusters/1/obLinks/batchAdd
{
"username": "proxyro",
"obClusterId": 1,
"clusterName": "hooray"
}
Return example
{
"duration": 121,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T16:48:32.957+08:00",
"traceId": "87dbc0dd2459490c"
}