OceanBase 集群重启 Zone

更新时间：2023-08-16 15:51:32

功能说明

该接口用于重启指定 OceanBase 集群的 Zone。

调用说明

接口约束

调用者需具备对目标 OceanBase 集群的管理权限。

关于调用者的权限，详情可参见安全概述。
调用者需要通过 OCP 应用服务鉴权。

请求路径

POST /api/v2/ob/clusters/{id}/zones/{zoneName}/restart

path：

参数	类型	必选	示例值	描述
id	Integer	是	1	需重启 Zone 的 OceanBase 集群 ID。
zoneName	String	是	1	需重启的 Zone 的名称。

返回结果

基础数据结构

参数	类型	说明
data	Object	异步任务信息，详情参见任务信息。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的应用服务的地址。

示例

请求示例

POST /api/v2/ob/clusters/1/zones/zone2/restart

返回示例

{
  "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": 89026581,
    "name": "Restart OB zone",
    "operation": "EXECUTE",
    "startTime": "2021-09-05T22:25:59.164+08:00",
    "status": "RUNNING",
    "subtasks": [
      {
        "className": "com.alipay.ocp.service.task.business.server.UpdateObServerStatusTask",
        "description": "Update observer status",
        "downstreams": [
          89029953
        ],
        "id": 89029965,
        "name": "Update observer status",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": 0,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 10,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          89029961
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.zone.StopObZoneTask",
        "description": "Stop zone",
        "downstreams": [
          89029954
        ],
        "id": 89029960,
        "name": "Stop zone",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 3,
        "status": "PENDING",
        "timeout": 1800,
        "upstreams": [
          89029952
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.obagent.StartOcpAgentServiceTask",
        "description": "Start ocp agent service",
        "downstreams": [
          89029961
        ],
        "id": 89029964,
        "name": "Start ocp agent service",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": 0,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 0,
        "status": "PENDING",
        "timeout": 1800,
        "upstreams": [
          89029962
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.WaitNode",
        "description": "Wait node",
        "downstreams": [
          89029955
        ],
        "id": 89029959,
        "name": "Wait node",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 4,
        "status": "PENDING",
        "timeout": 30,
        "upstreams": [
          89029954
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.zone.StartObZoneTask",
        "description": "Start zone",
        "downstreams": [
          89029956
        ],
        "id": 89029953,
        "name": "Start zone",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 11,
        "status": "PENDING",
        "timeout": 1800,
        "upstreams": [
          89029965
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.WaitNode",
        "description": "Wait node",
        "downstreams": [
          89029957
        ],
        "id": 89029963,
        "name": "Wait node",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 13,
        "status": "PENDING",
        "timeout": 30,
        "upstreams": [
          89029955
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.cluster.UpdateObClusterStatusTask",
        "description": "Update OB cluster status",
        "downstreams": [
          
        ],
        "id": 89029966,
        "name": "Update OB cluster status",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 14,
        "status": "PENDING",
        "timeout": 30,
        "upstreams": [
          89029958
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.WaitNode",
        "description": "Wait node",
        "downstreams": [
          89029965
        ],
        "id": 89029961,
        "name": "Wait node",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 8,
        "status": "PENDING",
        "timeout": 30,
        "upstreams": [
          89029964
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.server.PrepareRestartObServerTask",
        "description": "Prepare restart observer",
        "downstreams": [
          89029959
        ],
        "id": 89029954,
        "name": "Prepare restart observer",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": 0,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 9,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          89029960
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.zone.UpdateObZoneStatusTask",
        "description": "Update zone status",
        "downstreams": [
          89029958
        ],
        "id": 89029956,
        "name": "Update zone status",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 12,
        "status": "PENDING",
        "timeout": 1800,
        "upstreams": [
          89029953
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.server.WaitObServerActiveTask",
        "description": "Wait observer active",
        "downstreams": [
          89029964
        ],
        "id": 89029962,
        "name": "Wait observer active",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 5,
        "status": "PENDING",
        "timeout": 1800,
        "upstreams": [
          89029957
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.server.StartObServerProcessTask",
        "description": "Start observer process",
        "downstreams": [
          89029962
        ],
        "id": 89029957,
        "name": "Start observer process",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": 0,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 7,
        "status": "PENDING",
        "timeout": 1200,
        "upstreams": [
          89029963
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.zone.PrepareRestartObZoneTask",
        "description": "Prepare restart OB zone",
        "downstreams": [
          89029960
        ],
        "id": 89029952,
        "name": "Prepare restart OB zone",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 6,
        "status": "READY",
        "timeout": 1800,
        "upstreams": [
          
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.cluster.SyncClusterInfoTask",
        "description": "Sync cluster info",
        "downstreams": [
          89029966
        ],
        "id": 89029958,
        "name": "Sync cluster info",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 2,
        "status": "PENDING",
        "timeout": 30,
        "upstreams": [
          89029956
        ]
      },
      {
        "className": "com.alipay.ocp.service.task.business.server.StopObServerProcessTask",
        "description": "Stop observer process",
        "downstreams": [
          89029963
        ],
        "id": 89029955,
        "name": "Stop observer process",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": 0,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 1,
        "status": "PENDING",
        "timeout": 1200,
        "upstreams": [
          89029959
        ]
      }
    ],
    "taskDefinitionId": -1,
    "type": "MANUAL"
  },
  "duration": 144,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-05T22:25:59.226+08:00",
  "traceId": "80d78099a9984126"
}