Description
You can call this operation to start a zone 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}/zones/{zoneName}/start
Path parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Integer | Yes | 1 | The ID of the OceanBase cluster in which a zone needs to be started. |
| zoneName | String | Yes | 1 | The name of the zone. |
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/zones/zone2/start
Sample response
{
"data": {
"clusterId": 12000001,
"context": {
"listMap": {
"server_ids": [
"13000001"
]
},
"parallel": false,
"parallelIdx": -1,
"stringMap": {
"cluster_name": "protoss",
"cluster_id": "12000001",
"ocpagent_service_name": "agent",
"prohibit_rollback": "false",
"former_cluster_status": "RUNNING",
"zone_name": "zone2",
"target_cluster_status": "RUNNING"
}
},
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 89026548,
"name": "Start OB zone",
"operation": "EXECUTE",
"startTime": "2021-09-05T22:24:21.918+08:00",
"status": "RUNNING",
"subtasks": [
{
"className": "com.alipay.ocp.service.task.business.obagent.StartOcpAgentServiceTask",
"description": "Start ocp agent service",
"downstreams": [
89029907
],
"id": 89029906,
"name": "Start ocp agent service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89029912
]
},
{
"className": "com.alipay.ocp.service.task.business.WaitNode",
"description": "Wait node",
"downstreams": [
89029913
],
"id": 89029907,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"timeout": 30,
"upstreams": [
89029906
]
},
{
"className": "com.alipay.ocp.service.task.business.zone.StartObZoneTask",
"description": "Start zone",
"downstreams": [
89029914
],
"id": 89029909,
"name": "Start zone",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89029913
]
},
{
"className": "com.alipay.ocp.service.task.business.WaitNode",
"description": "Wait node",
"downstreams": [
89029917
],
"id": 89029916,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"timeout": 30,
"upstreams": [
89029915
]
},
{
"className": "com.alipay.ocp.service.task.business.cluster.SyncClusterInfoTask",
"description": "Sync cluster info",
"downstreams": [
89029910
],
"id": 89029908,
"name": "Sync cluster info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"timeout": 30,
"upstreams": [
89029914
]
},
{
"className": "com.alipay.ocp.service.task.business.server.UpdateObServerStatusTask",
"description": "Update observer status",
"downstreams": [
89029909
],
"id": 89029913,
"name": "Update observer status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"timeout": 300,
"upstreams": [
89029907
]
},
{
"className": "com.alipay.ocp.service.task.business.server.PrepareStartObServerTask",
"description": "Prepare start observer",
"downstreams": [
89029916
],
"id": 89029915,
"name": "Prepare start observer",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 6,
"status": "PENDING",
"timeout": 300,
"upstreams": [
89029911
]
},
{
"className": "com.alipay.ocp.service.task.business.zone.PrepareStartObZoneTask",
"description": "Prepare start OB zone",
"downstreams": [
89029915
],
"id": 89029911,
"name": "Prepare start OB zone",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 5,
"status": "READY",
"timeout": 1800,
"upstreams": [
]
},
{
"className": "com.alipay.ocp.service.task.business.zone.UpdateObZoneStatusTask",
"description": "Update zone status",
"downstreams": [
89029908
],
"id": 89029914,
"name": "Update zone status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89029909
]
},
{
"className": "com.alipay.ocp.service.task.business.cluster.UpdateObClusterStatusTask",
"description": "Update OB cluster status",
"downstreams": [
],
"id": 89029910,
"name": "Update OB cluster status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"timeout": 30,
"upstreams": [
89029908
]
},
{
"className": "com.alipay.ocp.service.task.business.server.StartObServerProcessTask",
"description": "Start observer process",
"downstreams": [
89029912
],
"id": 89029917,
"name": "Start observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"timeout": 1200,
"upstreams": [
89029916
]
},
{
"className": "com.alipay.ocp.service.task.business.server.WaitObServerActiveTask",
"description": "Wait observer active",
"downstreams": [
89029906
],
"id": 89029912,
"name": "Wait observer active",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89029917
]
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 130,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-05T22:24:21.981+08:00",
"traceId": "2b0b7be2a9e54478"
}
