Adding a Blacklist/Whitelist Rule to Multiple Policies At once
Function
This API is used to add a blacklist/whitelist rule to multiple policies at once.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/rule/whiteblackip
| 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 |
|---|---|---|---|
| policyids | No | String | Definition Policy ID list. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,). Constraints N/A Range N/A Default Value N/A |
| 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 | No | 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_ids | Yes | Array of strings | Definition IDs of policies to which rules are added. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,). Constraints Cannot be empty. Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | String | Rule ID. |
| name | String | Name of the whitelist or blacklist rule. |
| policyid | String | Policy ID. |
| addr | String | IP address or IP address ranges in the blacklist or whitelist rule, for example, 42.123.120.66 or 42.123.120.0/16. |
| white | Integer | Protective action |
| time_mode | String | The rule application method. Default value: permanent, indicating that the rule will be applied once it is configured. |
| start | Long | Time when the rule starts to take effect. This field is valid only when the effective mode is set to customize. |
| terminal | Long | Time when the rule becomes invalid. This field is valid only when the effective mode is set to customize. |
| ip_group | IpGroup object | IP address group. |
| status | Integer | Definition Rule status, which is used to specify whether a rule is enabled or disabled. Constraints N/A Range Default Value N/A |
| description | String | Rule description. |
| timestamp | Long | Time a rule is created. The value is a 13-digit timestamp in millisecond. |
| Parameter | Type | Description |
|---|---|---|
| id | String | ID of an IP address group, which is automatically generated by the system when an IP address group is added. |
| name | String | IP address group name. |
| size | Long | Number of IP addresses or IP address segments in an IP address group. |
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
Select multiple policies and add a blacklist/whitelist rule to them all at once.
POST https://{endpoint}/v1/{project_id}/waf/rule/whiteblackip?enterprise_project_id=0
{
"name" : "Create a rule to allow office network IP addresses.",
"addr" : "192.168.1.0/24,192.168.2.0/24",
"white" : 1,
"ip_group_id" : "ip-group-001",
"time_mode" : "permanent",
"policy_ids" : [ "a29c412353594920bfe1bf8a799f7b5a", "3d36b2f3f482462390f882bfb7460ca7" ]
} Example Responses
Status code: 200
Definition
OK
Constraints
N/A
Range
N/A
Default Value
N/A
{
"id" : "wbip-rule-001",
"name" : "Create a rule to allow office network IP addresses.",
"policyid" : "policy-wbip-202406",
"timestamp" : 1717248000000,
"status" : 1,
"addr" : "192.168.1.0/24,192.168.2.0/24",
"white" : 1,
"ip_group" : {
"id" : "ip-group-001",
"name" : "Office IP address group."
},
"time_mode" : "permanent"
} SDK Sample Code
The SDK sample code is as follows.
Select multiple policies and add a blacklist/whitelist rule to them all at once.
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 | 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 BatchCreateWhiteblackipRuleSolution { 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(); BatchCreateWhiteblackipRuleRequest request = new BatchCreateWhiteblackipRuleRequest(); BacthCreateWhiteBlackIpRuleRequestBody body = new BacthCreateWhiteBlackIpRuleRequestBody(); List<String> listbodyPolicyIds = new ArrayList<>(); listbodyPolicyIds.add("a29c412353594920bfe1bf8a799f7b5a"); listbodyPolicyIds.add("3d36b2f3f482462390f882bfb7460ca7"); body.withPolicyIds(listbodyPolicyIds); body.withTimeMode(BacthCreateWhiteBlackIpRuleRequestBody.TimeModeEnum.fromValue("permanent")); body.withIpGroupId("ip-group-001"); body.withWhite(1); body.withAddr("192.168.1.0/24,192.168.2.0/24"); body.withName("Create a rule to allow office network IP addresses."); request.withBody(body); try { BatchCreateWhiteblackipRuleResponse response = client.batchCreateWhiteblackipRule(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()); } } } |
Select multiple policies and add a blacklist/whitelist rule to them all at once.
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 | # 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 = BatchCreateWhiteblackipRuleRequest() listPolicyIdsbody = [ "a29c412353594920bfe1bf8a799f7b5a", "3d36b2f3f482462390f882bfb7460ca7" ] request.body = BacthCreateWhiteBlackIpRuleRequestBody( policy_ids=listPolicyIdsbody, time_mode="permanent", ip_group_id="ip-group-001", white=1, addr="192.168.1.0/24,192.168.2.0/24", name="Create a rule to allow office network IP addresses." ) response = client.batch_create_whiteblackip_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Select multiple policies and add a blacklist/whitelist rule to them all at once.
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 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.BatchCreateWhiteblackipRuleRequest{} var listPolicyIdsbody = []string{ "a29c412353594920bfe1bf8a799f7b5a", "3d36b2f3f482462390f882bfb7460ca7", } timeModeBacthCreateWhiteBlackIpRuleRequestBody:= model.GetBacthCreateWhiteBlackIpRuleRequestBodyTimeModeEnum().PERMANENT ipGroupIdBacthCreateWhiteBlackIpRuleRequestBody:= "ip-group-001" addrBacthCreateWhiteBlackIpRuleRequestBody:= "192.168.1.0/24,192.168.2.0/24" request.Body = &model.BacthCreateWhiteBlackIpRuleRequestBody{ PolicyIds: listPolicyIdsbody, TimeMode: &timeModeBacthCreateWhiteBlackIpRuleRequestBody, IpGroupId: &ipGroupIdBacthCreateWhiteBlackIpRuleRequestBody, White: int32(1), Addr: &addrBacthCreateWhiteBlackIpRuleRequestBody, Name: "Create a rule to allow office network IP addresses.", } response, err := client.BatchCreateWhiteblackipRule(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