Batch Deleting Protection Policies
Function
This API is used to batch delete protection policies.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/policies/batch-delete
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition Project ID, which is used to identify the project to which the tenant belongs. To obtain the project ID, log in to the console, click the username, choose My Credentials, locate the project in the Projects list, and check the project ID. Constraints N/A Range N/A Default Value N/A  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         enterprise_project_id  | 
       
         No  | 
       
         String  | 
       
         Definition Enterprise project ID. You can obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To query the resources associated with all enterprise projects of the current account, you do not need to specify this parameter. Constraints N/A Range N/A Default Value N/A  | 
      
Request Parameters
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         X-Auth-Token  | 
       
         Yes  | 
       
         String  | 
       
         Definition Tenant token, which is used for identity authentication. You can obtain the token by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A  | 
      
| 
         Content-Type  | 
       
         Yes  | 
       
         String  | 
       
         Definition Content type, which specifies the data format of the request body. Constraints N/A Range N/A Default Value application/json;charset=utf8  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         policy_ids  | 
       
         No  | 
       
         Array of strings  | 
       
         Definition Policy ID array, which contains the unique IDs of the protection policies to be deleted in batches. The IDs can be obtained by calling the API for querying the protection policy list. Constraints N/A Range The elements in the array are strings. Each element corresponds to a protection policy ID. Default Value N/A  | 
      
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         policy_ids  | 
       
         Array of strings  | 
       
         Definition Policy ID array, which contains the unique ID of each protection policy that has been deleted. Constraints N/A Range The elements in the array are strings, which correspond to the valid policy IDs in the request body. Default Value N/A  | 
      
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code.  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error message.  | 
      
| 
         encoded_authorization_message  | 
       
         String  | 
       
         You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.  | 
      
| 
         details  | 
       
         Array of IAM5ErrorDetails objects  | 
       
         The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes of the downstream service.  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error messages of the downstream service.  | 
      
Status code: 401
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code.  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error message.  | 
      
| 
         encoded_authorization_message  | 
       
         String  | 
       
         You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.  | 
      
| 
         details  | 
       
         Array of IAM5ErrorDetails objects  | 
       
         The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes of the downstream service.  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error messages of the downstream service.  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code.  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error message.  | 
      
| 
         encoded_authorization_message  | 
       
         String  | 
       
         You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.  | 
      
| 
         details  | 
       
         Array of IAM5ErrorDetails objects  | 
       
         The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.  | 
      
Example Requests
{
  "policy_ids" : [ "policy-123456" ]
}
  Example Responses
Status code: 200
OK
{
  "policy_ids" : [ "policy-123456" ]
}
  SDK Sample Code
The SDK sample code is as follows.
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49  | 
         
          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.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; public class BatchDeletePoliciesSolution { 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); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); BatchDeletePoliciesRequest request = new BatchDeletePoliciesRequest(); BatchDeletePoliciesRequestBody body = new BatchDeletePoliciesRequestBody(); request.withBody(body); try { BatchDeletePoliciesResponse response = client.batchDeletePolicies(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()); } } }  | 
        
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33  | 
         
          # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.v1 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 = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchDeletePoliciesRequest() request.body = BatchDeletePoliciesRequestBody( ) response = client.batch_delete_policies(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)  | 
        
          1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39  | 
         
          package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchDeletePoliciesRequest{} request.Body = &model.BatchDeletePoliciesRequestBody{ } response, err := client.BatchDeletePolicies(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }  | 
        
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| 
         Status Code  | 
       
         Description  | 
      
|---|---|
| 
         200  | 
       
         OK  | 
      
| 
         400  | 
       
         Request failed.  | 
      
| 
         401  | 
       
         The token does not have required permissions.  | 
      
| 
         500  | 
       
         Internal server error.  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot