首批通过分布式安全可靠测评,为关键业务系统打造
重启 OBServer 节点
更新时间:2023-08-16 15:51:32
功能说明
该接口用于重启目标 OceanBase 集群的 OBServer 节点。
调用说明
接口约束
调用者需具备对目标 OceanBase 集群的管理权限。
关于调用者的权限,详情可参见 安全概述。
调用者需要通过 OCP 应用服务鉴权。
请求路径
POST /api/v2/ob/clusters/{id}/servers/{serverId}/restart
path:
| 参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
| id | Integer | 是 | 1 | 目标集群的 ID。 |
| serverId | Integer | 是 | 1 | 需重启的 OBServer 节点的 ID。 |
请求参数
| 参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
| force | Boolean | 否 | false | 是否强制重启。 |
返回结果
基础数据结构
| 参数 | 类型 | 说明 |
|---|---|---|
| data | Object | 异步任务信息,详情参见 任务信息。 |
| successful | Boolean | 请求是否成功。 |
| timestamp | Datetime | 服务端完成请求的时间戳。 |
| duration | Integer | 服务端处理请求的时间(毫秒)。 |
| status | Integer | 符合 HTTP Status 规范的编码。 |
| traceId | String | 请求的 Trace ID,用于排查问题。 |
| server | String | 响应请求的应用服务的地址。 |
示例
请求示例
POST /api/v2/ob/clusters/1/servers/2/restart
返回示例
{
"data": {
"clusterId": 12000001,
"context": {
"listMap": {
"server_ids": [
"13000002"
]
},
"parallel": false,
"parallelIdx": -1,
"stringMap": {
"cluster_name": "protoss",
"cluster_id": "12000001",
"ocpagent_service_name": "agent",
"prohibit_rollback": "false",
"former_cluster_status": "RUNNING",
"target_zone_status": "RUNNING",
"former_zone_status": "RUNNING",
"zone_name": "zone2",
"target_cluster_status": "RUNNING",
"server_id": "13000002"
}
},
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 89027028,
"name": "Restart OB server",
"operation": "EXECUTE",
"startTime": "2021-09-05T22:46:20.22+08:00",
"status": "RUNNING",
"subtasks": [
{
"className": "com.alipay.ocp.service.task.business.cluster.SyncClusterInfoTask",
"description": "Sync cluster info",
"downstreams": [
89030474
],
"id": 89030480,
"name": "Sync cluster info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"timeout": 30,
"upstreams": [
89030478
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.StartOcpAgentServiceTask",
"description": "Start ocp agent service",
"downstreams": [
89030483
],
"id": 89030472,
"name": "Start ocp agent service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89030481
]
},
{
"className": "com.alipay.ocp.service.task.business.server.PrepareRestartObServerTask",
"description": "Prepare restart observer",
"downstreams": [
89030482
],
"id": 89030475,
"name": "Prepare restart observer",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 6,
"status": "READY",
"timeout": 300,
"upstreams": [
]
},
{
"className": "com.alipay.ocp.service.task.business.cluster.UpdateObClusterStatusTask",
"description": "Update OB cluster status",
"downstreams": [
],
"id": 89030474,
"name": "Update OB cluster status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"timeout": 30,
"upstreams": [
89030480
]
},
{
"className": "com.alipay.ocp.service.task.business.server.UpdateObServerStatusTask",
"description": "Update observer status",
"downstreams": [
89030478
],
"id": 89030473,
"name": "Update observer status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"timeout": 300,
"upstreams": [
89030483
]
},
{
"className": "com.alipay.ocp.service.task.business.zone.UpdateObZoneStatusTask",
"description": "Update zone status",
"downstreams": [
89030480
],
"id": 89030478,
"name": "Update zone status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89030473
]
},
{
"className": "com.alipay.ocp.service.task.business.server.StartObServerProcessTask",
"description": "Start observer process",
"downstreams": [
89030481
],
"id": 89030479,
"name": "Start observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"timeout": 1200,
"upstreams": [
89030476
]
},
{
"className": "com.alipay.ocp.service.task.business.server.StopObServerTask",
"description": "Stop server",
"downstreams": [
89030476
],
"id": 89030482,
"name": "Stop server",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"timeout": 300,
"upstreams": [
89030475
]
},
{
"className": "com.alipay.ocp.service.task.business.server.StartObServerTask",
"description": "Start server",
"downstreams": [
89030473
],
"id": 89030483,
"name": "Start server",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"timeout": 300,
"upstreams": [
89030472
]
},
{
"className": "com.alipay.ocp.service.task.business.server.WaitObServerActiveTask",
"description": "Wait observer active",
"downstreams": [
89030472
],
"id": 89030481,
"name": "Wait observer active",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"timeout": 1800,
"upstreams": [
89030479
]
},
{
"className": "com.alipay.ocp.service.task.business.server.StopObServerProcessTask",
"description": "Stop observer process",
"downstreams": [
89030479
],
"id": 89030476,
"name": "Stop observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"timeout": 1200,
"upstreams": [
89030482
]
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 155,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-05T22:46:20.277+08:00",
"traceId": "1f3af8df30ae4733"
}