文档首页/ 分布式缓存服务 DCS/ API参考/ 历史API/ 生命周期管理/ 批量删除实例
更新时间：2023-11-28 GMT+08:00
查看PDF
分享

批量删除实例

功能介绍

批量删除多个缓存实例。

URI

DELETE /v1.0/{project_id}/instances?allFailure={allFailure}

参数说明见表1。
表1 参数说明

参数

类型

必选

说明

project_id

String

是

项目ID。

allFailure

String

否

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

取值如下：

  • true，表示删除租户所有创建失败的缓存实例，此时请求参数instances可为空；
  • false或者其他值，表示删除instances参数数组中指定的缓存实例。

请求消息

请求参数

参数说明见表2。
表2 参数说明

参数

类型

必选

说明

instances

Array

否

实例的ID列表。

仅当URI中参数allFailure值为“false”或者其他值时，才需要配置该参数。

一次最多可删除50个实例。

请求URL:

DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure}

当allFailure为false时，请求示例如下：

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

响应消息

响应参数

当URI中参数allFailure值为true时，响应返回为空。当URI中参数allFailure值为false时，参数说明见表3。
表3 参数说明

参数

类型

说明

results

Array

删除实例的结果，具体请参考表4。
表4 results参数说明

参数

类型

说明

instance

String

缓存实例ID。

result

String

操作结果，取值有success或failed。

响应示例

{
    "results": [
        {
            "instance": "54602a9d-5e22-4239-9123-77e350df4a34",
            "result": "success"
        },
        {
            "instance": "7166cdea-dbad-4d79-9610-7163e6f8b640",
            "result": "success"
        }
    ]
}

状态码

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

表5 状态码

状态码

描述

200

批量删除缓存实例成功。

204

清理创建失败的缓存实例成功。
父主题： 生命周期管理

相关文档