This API is used to start an OceanBase cluster.
Call description
Limitations
If you set a password in the request, you must specify the X-OCS-Auth field in the header for authentication. For more information, see Authentication based on public-key encryption.
Request path
POST /api/v1/ob/start
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| scope | Object | Yes | For more information, see SetServerConfig. | The scope of the OBServer nodes that you want to start. |
| forcePassDag | []String | No | The ID of the preceding task that starts or stops the specified OBServer nodes. You can use this parameter in special circumstances. When a cluster O&M task is locked by one or more preceding tasks, you can specify this parameter to release the previous tasks. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. |
| data | Object | The information about the asynchronous task. For more information, see GetDagDetails. |
| error | Object | The information about the error that occurred. |
Examples
Sample request
POST xxx.xxx.1:2886/api/v1/ob/start
{
"scope": {
"type": "GLOBAL"
}
}
Sample response
{
"successful": true,
"timestamp": "2024-01-10T11:24:44.515966754+08:00",
"duration": 3,
"status": 200,
"traceId": "c697089607fac2f1",
"data": {
"id": "22130706433028869",
"dag_id": 13,
"name": "Start OB",
"stage": 1,
"max_stage": 6,
"state": "READY",
"operator": "RUN",
"start_time": "2024-01-10T11:24:44.513664697+08:00",
"end_time": "2024-01-10T11:24:44.513664697+08:00",
"additional_data": null,
"nodes": null
}
}