欢迎访问 OceanBase 官网获取更多信息：https://www.oceanbase.com/
功能说明
该接口用于停止目标 OceanBase 集群的 OBServer 节点。
调用说明
接口约束
- 调用者需具备对目标 OceanBase 集群的管理权限。
关于调用者的权限，详情可参见 安全概述。
- 调用者需要通过 OCP 应用服务鉴权。
请求路径
POST /api/v2/ob/clusters/{id}/servers/{serverId}/stop
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/stop
返回示例
{
"data": {
"cluster": {
"id": 20,
"name": "ob_upgrade",
"obClusterId": 20
},
"context": "Context(parallelIdx=-1, stringMap={cluster_id=20, 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": 111102,
"name": "Stop OB server",
"startTime": "2021-03-02T16:11:11.327+08:00",
"status": "RUNNING",
"tasks": [
{
"description": "Wait observer stop",
"downstreams": [
133821
],
"id": 133815,
"name": "Wait observer stop",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133816
]
},
{
"description": "Stop observer process",
"downstreams": [
133815
],
"id": 133816,
"name": "Stop observer process",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133818
]
},
{
"description": "Update OB cluster status",
"downstreams": [
],
"id": 133817,
"name": "Update OB cluster status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133819
]
},
{
"description": "Stop server",
"downstreams": [
133816
],
"id": 133818,
"name": "Stop server",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133820
]
},
{
"description": "Sync cluster info",
"downstreams": [
133817
],
"id": 133819,
"name": "Sync cluster info",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133822
]
},
{
"description": "Prepare stop observer",
"downstreams": [
133818
],
"id": 133820,
"name": "Prepare stop observer",
"operation": "EXECUTE",
"status": "RUNNING",
"upstreams": [
]
},
{
"description": "Update observer status",
"downstreams": [
133822
],
"id": 133821,
"name": "Update observer status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133815
]
},
{
"description": "Update zone status",
"downstreams": [
133819
],
"id": 133822,
"name": "Update zone status",
"operation": "EXECUTE",
"status": "PENDING",
"upstreams": [
133821
]
}
]
},
"duration": 140,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-03-02T16:11:11.373+08:00",
"traceId": "139d82c5f88f42f4"
}
欢迎访问 OceanBase 官网获取更多信息：https://www.oceanbase.com/
