Batch Updating Blacklist and Whitelist Rules
Function
This API is used to batch update blacklist and whitelist rules.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/rule/whiteblackip/batch-update
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range The value contains 32 characters. Only letters and digits are supported. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterprise_project_id | No | String | Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range Default Value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user 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. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Rule name. Constraints Length range: [1, 256] Range N/A Default Value N/A |
| addr | No | String | Definition IP address or IP address segment. Example: 42.123.120.66 or 42.123.120.0/16 Constraints Either addr or ip_group_id must be specified. If both are specified, addr takes precedence. Range N/A Default Value N/A |
| description | No | String | Description of the blacklist or whitelist rule. |
| white | Yes | Integer | Definition Protective action. Constraints N/A Range Default Value N/A |
| ip_group_id | No | String | Definition ID of an IP address group. You can go to the console and add an IP address group on the Objects > Address Groups page. Constraints Either addr or ip_group_id must be specified. If both are specified, addr takes precedence. Range N/A Default Value N/A |
| time_mode | No | String | Definition Activation mode Constraints N/A Range Default Value permanent |
| start | No | Integer | Time when the rule starts to take effect. This field is valid only when the effective mode is set to customize. Enter a timestamp. |
| terminal | No | Integer | Time when the rule becomes invalid. This field is valid only when the effective mode is set to customize. Enter a timestamp. |
| policy_rule_ids | Yes | Array of policy_rule_ids objects | Definition Array of policy and rule IDs. It associates a protection policy with the corresponding rule set. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| policy_id | Yes | String | Definition Policy ID, which uniquely identifies a protection policy. You can obtain the policy ID by calling the ListPolicy API for querying the list of protection policies. Constraints N/A Range N/A Default Value N/A |
| rule_ids | Yes | Array of strings | Definition Rule ID array, including the ID of a single blacklist or whitelist rule in the current protection policy. You can obtain the rule ID by calling the API for querying the list of blacklist and whitelist rules (ListWhiteblackipRule). Constraints ID of a single rule. Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| policy_rule_ids | Array of policy_rule_ids objects | Definition Policy and rule ID array. It shows the association between the protection policy and the corresponding rule IDs. Constraints N/A Range N/A Default Value N/A |
| Parameter | Type | Description |
|---|---|---|
| policy_id | String | Definition Policy ID, which uniquely identifies a protection policy. Constraints N/A Range N/A Default Value N/A |
| rule_ids | Array of strings | Definition Rule ID array. IDs of rules in the current protection policy are returned. Constraints N/A Range N/A 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
Batch update blacklist and whitelist rules.
POST https://{endpoint}/v1/{project_id}/waf/rule/whiteblackip/batch-update?enterprise_project_id=0
{
"name" : "demo",
"addr" : "x.x.x.x24",
"description" : "demo",
"white" : 2,
"policy_rule_ids" : [ {
"rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
"policy_id" : "4a34899ab17a4811a6da57742f69135a"
} ]
} Example Responses
Status code: 200
Definition
OK
Constraints
N/A
Range
N/A
Default Value
N/A
{
"policy_rule_ids" : [ {
"rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
"policy_id" : "4a34899ab17a4811a6da57742f69135a"
} ]
} SDK Sample Code
The SDK sample code is as follows.
Batch update blacklist and whitelist rules.
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | 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.*; import java.util.List; import java.util.ArrayList; public class BatchUpdateWhiteblackipRulesSolution { 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(); BatchUpdateWhiteblackipRulesRequest request = new BatchUpdateWhiteblackipRulesRequest(); BatchUpdateWhiteBlackIpRuleRequestBody body = new BatchUpdateWhiteBlackIpRuleRequestBody(); List<String> listPolicyRuleIdsRuleIds = new ArrayList<>(); listPolicyRuleIdsRuleIds.add("ed37d85a925d469bb01986d06291d15f"); List<BatchUpdateWhiteBlackIpRuleRequestBodyPolicyRuleIds> listbodyPolicyRuleIds = new ArrayList<>(); listbodyPolicyRuleIds.add( new BatchUpdateWhiteBlackIpRuleRequestBodyPolicyRuleIds() .withPolicyId("4a34899ab17a4811a6da57742f69135a") .withRuleIds(listPolicyRuleIdsRuleIds) ); body.withPolicyRuleIds(listbodyPolicyRuleIds); body.withWhite(2); body.withDescription("demo"); body.withAddr("x.x.x.x24"); body.withName("demo"); request.withBody(body); try { BatchUpdateWhiteblackipRulesResponse response = client.batchUpdateWhiteblackipRules(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()); } } } |
Batch update blacklist and whitelist rules.
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 | # 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 = BatchUpdateWhiteblackipRulesRequest() listRuleIdsPolicyRuleIds = [ "ed37d85a925d469bb01986d06291d15f" ] listPolicyRuleIdsbody = [ BatchUpdateWhiteBlackIpRuleRequestBodyPolicyRuleIds( policy_id="4a34899ab17a4811a6da57742f69135a", rule_ids=listRuleIdsPolicyRuleIds ) ] request.body = BatchUpdateWhiteBlackIpRuleRequestBody( policy_rule_ids=listPolicyRuleIdsbody, white=2, description="demo", addr="x.x.x.x24", name="demo" ) response = client.batch_update_whiteblackip_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Batch update blacklist and whitelist rules.
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.BatchUpdateWhiteblackipRulesRequest{} var listRuleIdsPolicyRuleIds = []string{ "ed37d85a925d469bb01986d06291d15f", } var listPolicyRuleIdsbody = []model.BatchUpdateWhiteBlackIpRuleRequestBodyPolicyRuleIds{ { PolicyId: "4a34899ab17a4811a6da57742f69135a", RuleIds: listRuleIdsPolicyRuleIds, }, } descriptionBatchUpdateWhiteBlackIpRuleRequestBody:= "demo" addrBatchUpdateWhiteBlackIpRuleRequestBody:= "x.x.x.x24" request.Body = &model.BatchUpdateWhiteBlackIpRuleRequestBody{ PolicyRuleIds: listPolicyRuleIdsbody, White: int32(2), Description: &descriptionBatchUpdateWhiteBlackIpRuleRequestBody, Addr: &addrBatchUpdateWhiteBlackIpRuleRequestBody, Name: "demo", } response, err := client.BatchUpdateWhiteblackipRules(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 | Definition OK Constraints N/A Range N/A Default Value N/A |
| 400 | Definition Request failed. Constraints N/A Range N/A Default Value N/A |
| 401 | Definition The token does not have required permissions. Constraints N/A Range N/A Default Value N/A |
| 500 | Definition Internal server error. Constraints N/A Range N/A Default Value N/A |
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