文档首页/ 分布式缓存服务 DCS/ API参考（巴黎区域）/ API V2（推荐）/ 生命周期管理/ 批量删除实例
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

批量删除实例

功能介绍

批量删除多个缓存实例。

URI

DELETE /v2/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

all_failure

否

Boolean

是否批量删除创建失败的缓存实例。取值如下：

  • true，表示删除租户所有创建失败的缓存实例，此时请求参数instances可为空；

  • false或者其他值，表示删除instances参数数组中指定的缓存实例。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

instances

否

Array of strings

实例的ID列表。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

results

Array of BatchOpsResult objects

删除/重启/清空实例的结果。
表5 BatchOpsResult

参数

参数类型

描述

result

String

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

instance

String

缓存实例ID。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

请求示例

批量删除缓存实例。

DELETE https://{dcs_endpoint}/v2/{project_id}/instances?all_failure={all_failure}

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

响应示例

状态码： 200

批量删除缓存实例成功。

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

状态码

状态码

描述

200

批量删除缓存实例成功。

500

内部服务错误。

400

非法请求。

错误码

请参见错误码。

父主题： 生命周期管理