# 批量删除实例 - BatchDeleteInstances #### 功能介绍 批量删除多个缓存实例。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:delete | Write | instance | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - vpc:ports:get - vpc:ports:create - vpc:ports:update - vpc:ports:delete - vpc:subnets:get | #### URI DELETE /v2/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | **参数解释**： 删除/重启/清空实例的结果。 | 表5BatchOpsResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释**： 操作结果。 **取值范围**： success：删除/重启/清空实例成功。 failed：删除/重启/清空实例失败。 | | instance | String | **参数解释**： 缓存实例ID。 **取值范围**： 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | #### 请求示例 批量删除缓存实例。 ``` 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" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 批量删除缓存实例。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; import java.util.List; import java.util.ArrayList; public class BatchDeleteInstancesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("")) .build(); BatchDeleteInstancesRequest request = new BatchDeleteInstancesRequest(); BatchDeleteBody body = new BatchDeleteBody(); List listbodyInstances = new ArrayList<>(); listbodyInstances.add("54602a9d-5e22-4239-9123-77e350df4a34"); listbodyInstances.add("7166cdea-dbad-4d79-9610-7163e6f8b640"); body.withInstances(listbodyInstances); request.withBody(body); try { BatchDeleteInstancesResponse response = client.batchDeleteInstances(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 批量删除缓存实例。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("")) \ .build() try: request = BatchDeleteInstancesRequest() listInstancesbody = [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ] request.body = BatchDeleteBody( instances=listInstancesbody ) response = client.batch_delete_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 批量删除缓存实例。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.BatchDeleteInstancesRequest{} var listInstancesbody = []string{ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640", } request.Body = &model.BatchDeleteBody{ Instances: &listInstancesbody, } response, err := client.BatchDeleteInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=BatchDeleteInstances&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 批量删除缓存实例成功。 | | 400 | 非法请求。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。