This API operation is used to start an OceanBase cluster.
Call description
Limitations
The OceanBase Shell (obshell) server verifies the security of requests to this API operation. For more information, see Hybrid encryption for API operations.
Request path
POST /api/v1/ob/start
Request parameters
| Parameter | Type | Required? | Example value | Description |
|---|---|---|---|---|
| scope | Scope | Yes | { "type": "GLOBAL" } |
The scope of OBServer nodes on which the parameters take effect. For more information, see the data structure of Scope. |
| forcePassDag | []string | No | N/A | 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. |
The following table describes the data structure of Scope.
| Parameter | Type | Required? | Example value | Description |
|---|---|---|---|---|
| type | String | Yes | "GLOBAL" | The type of scope in which the parameters take effect. Valid values include GLOBAL, ZONE, and SERVER. |
| target | []string | No | ["10.10.10.1:2886", "10.10.10.2:2886"] or ["zone1","zone2"] | The specific scope in which the parameters take effect. If you set the type parameter to SERVER, you must set this parameter to a list of OBServer nodes. If you set the type parameter to ZONE, you must set this parameter to a list of zones. If you set the type parameter to GLOBAL, you do not need to specify this parameter. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | time.Time | 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 | DagDetailDTO | The details of the directed acyclic graph (DAG) task. For more information, see the data structure of DagDetailDTO. |
| error | ApiError | The error caused by the request, which contains the following information:
|
The following table describes the data structure of DagDetailDTO.
| Parameter | Type | Description |
|---|---|---|
| id | String | The general ID of the DAG task. |
| dag_id | Integer | The ID of the DAG task, which is the primary key recorded in OceanBase Database. |
| name | String | The name of the DAG task. |
| stage | Integer | The current stage of the DAG task. |
| max_stage | Integer | The total number of stages of the DAG task during execution. |
| state | String | The execution status of the DAG task. |
| operator | String | The operation type of the DAG task. |
| start_time | time.Time | The time when the execution of the DAG task started. |
| end_time | time.Time | The time when the execution of the DAG task ended. |
| additional_data | map[string]any | Other data of the DAG task. |
| nodes | []NodeDetailDTO | The information about all OBServer nodes involved in the DAG task. For more information, see GetNodeDetails. |
Examples
Sample request
POST 10.10.10.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
}
}
References
In addition to using the CLI, you can use SDKs to call the API operation.
For more information about how to call the API operation by using obshell-sdk-python, see Start a cluster.
For more information about how to call the API operation by using obshell-sdk-go, see Start a cluster.