Description
You can call this operation to start an OceanBase cluster.
Call description
Call description
Prerequisites
Prerequisites
- You have the permission to start the OceanBase cluster.
Request path
Request path
Request parameters
Path parameters: Path parameters
id |
Long |
Yes |
1 |
The ID of the OceanBase cluster to be started. |
|---|
Response parameters
| id | Long | Yes | 1 | The ID of the OceanBase cluster to be started. | Basic data structure Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| data | Object | The information about the asynchronous task. For more information, see Task information. |
| 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 application server that responded to the request. |
Examples
Sample request
Sample request
POST /api/v2/ob/clusters/1/start
Sample response
Sample response
{
"data": {
"cluster": {
"id": 21,
"name": "ob_upgrade",
"obClusterId": 22
},
"context": "Context(parallelIdx=-1, stringMap={cluster_name=ob_upgrade, cluster_id=21, ocpagent_service_name=agent}, listMap={server_ids=[5], host_ids=[5], zone_names=[zone1]})",
"creator": {
"id": 100,
"name": "admin"
},
"id": 107330,
"name": "Start OB cluster",
"startTime": "2021-03-02T10:31:42.285+08:00",
"status": "RUNNING",
"tasks": [
{
"description": "Wait node",
"downstreams": [
128848
],
"id": 128836,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128843
]
},
{
"description": "Wait node",
"downstreams": [
128845
],
"id": 128837,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128842
]
},
{
"description": "Update OB cluster status",
"downstreams": [
],
"id": 128838,
"name": "Update OB cluster status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128849
]
},
{
"description": "Start ocp agent service",
"downstreams": [
128853
],
"id": 128839,
"name": "Start ocp agent service",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128841
]
},
{
"description": "Prepare start cluster",
"downstreams": [
128846
],
"id": 128840,
"name": "Prepare start cluster",
"operation": "EXECUTE",
"status": "RUNNING",
"upstreams": [
]
},
{
"description": "Wait observer accessible",
"downstreams": [
128839
],
"id": 128841,
"name": "Wait observer accessible",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128850
]
},
{
"description": "Update observer status",
"downstreams": [
128837
],
"id": 128842,
"name": "Update observer status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128847
]
},
{
"description": "Start server",
"downstreams": [
128836
],
"id": 128843,
"name": "Start server",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128853
]
},
{
"description": "Prepare start observer",
"downstreams": [
128851
],
"id": 128844,
"name": "Prepare start observer",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128852
]
},
{
"description": "Update zone status",
"downstreams": [
128849
],
"id": 128845,
"name": "Update zone status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128837
]
},
{
"description": "Prepare start OB zone",
"downstreams": [
128852
],
"id": 128846,
"name": "Prepare start OB zone",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128840
]
},
{
"description": "Wait node",
"downstreams": [
128842
],
"id": 128847,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128848
]
},
{
"description": "Start zone",
"downstreams": [
128847
],
"id": 128848,
"name": "Start zone",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128836
]
},
{
"description": "Sync all tenant information",
"downstreams": [
128838
],
"id": 128849,
"name": "Sync all tenant information",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128845
]
},
{
"description": "Start observer process",
"downstreams": [
128841
],
"id": 128850,
"name": "Start observer process",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128851
]
},
{
"description": "Wait node",
"downstreams": [
128850
],
"id": 128851,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128844
]
},
{
"description": "Wait node",
"downstreams": [
128844
],
"id": 128852,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128846
]
},
{
"description": "Wait node",
"downstreams": [
128843
],
"id": 128853,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128839
]
}
]
},
"duration": 116,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-03-02T10:31:42.362+08:00",
"traceId": "71abcaaaff9440b9"
}
{
"data": {
"cluster": {
"id": 21,
"name": "ob_upgrade",
"obClusterId": 22
},
"context": "Context(parallelIdx=-1, stringMap={cluster_name=ob_upgrade, cluster_id=21, ocpagent_service_name=agent}, listMap={server_ids=[5], host_ids=[5], zone_names=[zone1]})",
"creator": {
"id": 100,
"name": "admin"
},
"id": 107330,
"name": "Start OB cluster",
"startTime": "2021-03-02T10:31:42.285+08:00",
"status": "RUNNING",
"tasks": [
{
"description": "Wait node",
"downstreams": [
128848
],
"id": 128836,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128843
]
},
{
"description": "Wait node",
"downstreams": [
128845
],
"id": 128837,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128842
]
},
{
"description": "Update OB cluster status",
"downstreams": [
],
"id": 128838,
"name": "Update OB cluster status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128849
]
},
{
"description": "Start ocp agent service",
"downstreams": [
128853
],
"id": 128839,
"name": "Start ocp agent service",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128841
]
},
{
"description": "Prepare start cluster",
"downstreams": [
128846
],
"id": 128840,
"name": "Prepare start cluster",
"operation": "EXECUTE",
"status": "RUNNING",
"upstreams": [
]
},
{
"description": "Wait observer accessible",
"downstreams": [
128839
],
"id": 128841,
"name": "Wait observer accessible",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128850
]
},
{
"description": "Update observer status",
"downstreams": [
128837
],
"id": 128842,
"name": "Update observer status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128847
]
},
{
"description": "Start server",
"downstreams": [
128836
],
"id": 128843,
"name": "Start server",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128853
]
},
{
"description": "Prepare start observer",
"downstreams": [
128851
],
"id": 128844,
"name": "Prepare start observer",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128852
]
},
{
"description": "Update zone status",
"downstreams": [
128849
],
"id": 128845,
"name": "Update zone status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128837
]
},
{
"description": "Prepare start OB zone",
"downstreams": [
128852
],
"id": 128846,
"name": "Prepare start OB zone",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128840
]
},
{
"description": "Wait node",
"downstreams": [
128842
],
"id": 128847,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128848
]
},
{
"description": "Start zone",
"downstreams": [
128847
],
"id": 128848,
"name": "Start zone",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128836
]
},
{
"description": "Sync all tenant information",
"downstreams": [
128838
],
"id": 128849,
"name": "Sync all tenant information",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128845
]
},
{
"description": "Start observer process",
"downstreams": [
128841
],
"id": 128850,
"name": "Start observer process",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128851
]
},
{
"description": "Wait node",
"downstreams": [
128850
],
"id": 128851,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128844
]
},
{
"description": "Wait node",
"downstreams": [
128844
],
"id": 128852,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128846
]
},
{
"description": "Wait node",
"downstreams": [
128843
],
"id": 128853,
"name": "Wait node",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
128839
]
}
]
},
"duration": 116,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-03-02T10:31:42.362+08:00",
"traceId": "71abcaaaff9440b9"
}