更新时间:2024-01-24 GMT+08:00

批量重启、删除实例

当前页面API为历史版本API,未来可能停止维护。请使用批量重启或删除实例

功能介绍

批量重启或删除实例。

在实例重启过程中,客户端的生产与消费消息等请求会被拒绝。

实例删除后,实例中原有的数据将被删除,且没有备份,请谨慎操作。

URI

POST /v1.0/{project_id}/instances/action

参数说明见表1

表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

请求消息

请求参数

参数说明见表2

表2 参数说明

参数

类型

必选

说明

action

String

对实例的操作:restart、delete

instances

Array

实例的ID列表。

allFailure

String

是否批量删除创建失败的实例。

当参数值为“true”时,删除租户所有创建失败的实例,此时请求参数instances可为空。

请求示例

批量重启实例

{ 
    "action" : "restart", 
    "instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"] 
}

批量删除实例

{ 
    "action" : "delete", 
    "instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"] 
}

删除所有创建失败的实例

{ 
    "action" : "delete", 
    "allFailure" : "true"
}

响应消息

响应参数

当参数action为delete,allFailure值为true时,响应返回为空表示删除成功。参数说明见表3

表3 参数说明

参数

类型

说明

results

Array

修改实例的结果。

表4 results参数说明

参数

类型

说明

instance

String

实例ID。

result

String

操作结果:success、failed。

响应示例

{ 
    "results": [ 
        { 
            "result": "success", 
            "instance": "afc90a2a-a02c-4cba-94d5-58dfa9ad1e0d" 
        }, 
        { 
            "result": "success", 
            "instance": "67fc5f8d-3986-4f02-bb75-4075a23112de" 
        } 
    ] 
}

状态码

操作成功的状态码如表5所示,其他响应见状态码

表5 状态码

状态码

描述

200

重启或者删除实例成功。