下载
中文
注册

集群节点停止服务接口

接口功能

停止集群节点服务。

该接口不需要用户调用,属于Coordinator和Controllor之间的通信接口。

端口类型

管理端口。

接口格式

操作类型:POST

URL:https://{ip}:{port}/v1/instances/offline

  • {ip}优先取启动命令参数中的{manage_ip};如果没有配置该命令行参数,则取配置文件ms_coordinator.json的“manage_ip”参数。
  • {port}优先取启动命令参数中的{manage_port};如果没有配置该命令行参数,则取配置文件ms_coordinator.json的“manage_port”参数。

请求参数

参数

类型

说明

ids

uint64_t[]

必填。

停止服务的节点ID。

使用样例

请求样例:

POST https://{ip}:{port}/v1/instances/offline

请求消息体:

{
    "ids": [
        0,1
    ]
}

响应样例:

正常时无响应消息体。

输出说明

  • 请求的消息体json格式和字段正确时,返回http200状态码。
  • 当Coordinator未就绪时,返回http503状态码。
  • 当请求消息体格式错误时,返回http400状态码。