批量删除节点
此接口用于删除已注册节点。如果节点上已部署容器实例,则不允许删除。
接口描述
通信协议:HTTP
URL:DELETE /api/v1/node
传参方式:body
请求参数
字段名 | 类型 | 是否必填 | 说明 |
---|---|---|---|
ids | string[ ] | 是 | 节点 ID 列表 |
响应参数
字段名 | 类型 | 说明 |
---|---|---|
data | string / List[ ] | 操作结果,success 表示删除成功。当返回 array 时表⽰节点存在被服务占⽤的情况 |
List
字段名 | 类型 | 说明 |
---|---|---|
id | string | 节点 ID |
name | string | 节点名称 |
serves | Servers[ ] | 服务信息 |
Servers
字段名 | 类型 | 说明 |
---|---|---|
id | string | 服务 ID |
name | string | 服务名称 |
请求示例
curl --location --request DELETE 'http://localhost:3001/api/v1/node' --header 'Content-Type: application/json' --data-raw '{
"ids": ["af2eb355-a8ca-4023-8e3b-7efe7d4a9c47"]
}'
响应示例
删除成功响应示例:
{ "status": 200, "message": "success", "fieldErrors": null, "data": "success" }
删除失败响应示例:
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": [
{
"id": "af2eb355-a8ca-4023-8e3b-7efe7d4a9c47",
"name": "192.168.XX.XX",
"serves": [
{
"id": "124f9c3e-7269-4be9-b4a6-3eeba25241db",
"name": "aaa"
}
]
}
]
}
错误码
具体请参见 错误码说明。