下线有状态的节点

下线接口用于通知有状态节点(tikv,tiflash,pump)开始下线。  
有状态的节点在下线前会切走流量并迁移数据，这需要时间，在数据完成迁移后，节点状态会被标记为`offlined`,此时可调用标准缩容流程删除节点。  
下线操作是同步的，不使用任务流，不会锁定集群，保证集群可用的情况下，可以执行其他运维操作。

:::tip 参数
TransferTimeout: 切换Leader时的超时时间。默认600秒。  
Force: 强制删除节点元数据。
:::

:::caution 注意
下线接口必须提供节点ID列表。  
下线时，如果节点已经下线或在下线中，会自动忽略。请根据返回值判断触发下线的节点。
:::
:::danger 危险
支持 Force 参数，请小心使用，此时 TiUP 只会删除元数据，请在确保节点已经彻底无法访问时使用。
:::

接口URL

/api/v1/cluster/tidbs/{clusterID}/offline

请求方式

POST

Content-Type

application/json

请求Header参数

路径变量

请求Body参数

{
    "instanceIDs": [
        "inst-tikv-068459ec367a"
    ]
}

认证方式

Bearer auth

路径变量

成功响应示例

{
    "Data": [
        "172.17.0.6:20163"
    ],
    "Success": true
}