Description
You can call this operation to start an OBServer in an OceanBase cluster.
Call description
Prerequisites
You have the permissions to manage the OceanBase cluster.
For more information about the permissions, see Roles overview and Users Overview.
You have passed the authentication for the OCP application service.
Request path
POST /api/v2/ob/clusters/{id}/servers/{serverId}/start
Path parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Integer | Yes | 1 | The ID of the OceanBase cluster. |
| serverId | Integer | Yes | 1 | The ID of the OBServer to be started. |
Response parameters
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
POST /api/v2/ob/clusters/1/servers/2/start
Sample response
{
"data": {
"cluster": {
"id": 20,
"name": "ob_upgrade",
"obClusterId": 20
},
"context": "Context(parallelIdx=-1, stringMap={cluster_name=ob_upgrade, cluster_id=20, ocpagent_service_name=agent, former_cluster_status=RUNNING, target_zone_status=RUNNING, former_zone_status=RUNNING, zone_name=zone2, target_cluster_status=RUNNING, server_id=3}, listMap={server_ids=[3]})",
"creator": {
"id": 100,
"name": "admin"
},
"id": 111125,
"name": "Start OB server",
"startTime": "2021-03-02T16:13:17.818+08:00",
"status": "RUNNING",
"tasks": [
{
"description": "Start observer process",
"downstreams": [
133855
],
"id": 133851,
"name": "Start observer process",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133858
]
},
{
"description": "Update observer status",
"downstreams": [
133853
],
"id": 133852,
"name": "Update observer status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133854
]
},
{
"description": "Update zone status",
"downstreams": [
133859
],
"id": 133853,
"name": "Update zone status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133852
]
},
{
"description": "Start server",
"downstreams": [
133852
],
"id": 133854,
"name": "Start server",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133856
]
},
{
"description": "Wait observer active",
"downstreams": [
133856
],
"id": 133855,
"name": "Wait observer active",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133851
]
},
{
"description": "Start ocp agent service",
"downstreams": [
133854
],
"id": 133856,
"name": "Start ocp agent service",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133855
]
},
{
"description": "Update OB cluster status",
"downstreams": [
],
"id": 133857,
"name": "Update OB cluster status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133859
]
},
{
"description": "Prepare start observer",
"downstreams": [
133851
],
"id": 133858,
"name": "Prepare start observer",
"operation": "EXECUTE",
"status": "RUNNING",
"upstreams": [
]
},
{
"description": "Sync cluster info",
"downstreams": [
133857
],
"id": 133859,
"name": "Sync cluster info",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133853
]
}
]
},
"duration": 155,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-03-02T16:13:17.875+08:00",
"traceId": "be31d61b70df4858"
}