更新时间:2025-12-29 GMT+08:00

批量删除实例

功能介绍

批量删除多个缓存实例。

URI

DELETE /v2/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

all_failure

否

Boolean

参数解释:

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

约束限制:

不涉及。

取值范围:

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

  • false:表示删除instances参数数组中指定的缓存实例。

默认取值:

false。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

instances

否

Array of strings

参数解释:

实例的ID列表。仅当URI中参数all_failure值为“false”或者其他值时,才需要配置该参数。

约束限制:

不涉及。

is_recycle

否

Boolean

参数解释:

实例删除后是否放入回收站。

约束限制:

Redis 4.0及以上版本的实例支持放入回收站。

取值范围:

true:表示删除实例放入回收站。

false:表示删除实例不放入回收站,直接销毁。

默认取值:

false

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

results

Array of BatchOpsResult objects

参数解释:

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

表5 BatchOpsResult

参数

参数类型

描述

result

String

参数解释:

操作结果。

取值范围:

success:删除/重启/清空实例成功。

failed:删除/重启/清空实例失败。

instance

String

参数解释:

缓存实例ID。

取值范围:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

请参见错误码。

error_ext_msg

String

参数解释:

扩展错误信息(暂未使用,赋值为null)。

取值范围:

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

请参见错误码。

error_ext_msg

String

参数解释:

扩展错误信息(暂未使用,赋值为null)。

取值范围:

不涉及。

请求示例

批量删除缓存实例。

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

批量删除缓存实例成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码。