Adding a Global Protection Whitelist Rule to Multiple Policies At Once
Function
This API is used to add a global protection whitelist rule to multiple policies at once.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/rule/ignore
| 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 Protection policy ID. You can call the ListPolicy API to obtain the policy ID. 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 | 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 |
|---|---|---|---|
| domain | Yes | Array of strings | Domain names or websites to be protected. If the array length is 0, the rule takes effect for all domain names or websites. If Cloud Mode - Load balancer access is used for the domain name, set this parameter in the format of [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:<id>, for example, www.example.com:b061fb5b-8ea0-4357-b0f4-cb6178ab378a. If all listeners of the load balancer bound to the domain name are protected by WAF, set this parameter to the load balancer ID. Otherwise, set this parameter to the listener ID. To query the load balancer ID bound to the domain name, use the ShowPremiumHost API. To query the listener ID, check the API documentation of ELB in the help center. |
| conditions | Yes | Array of CreateCondition objects | Condition list. |
| mode | Yes | Integer | Version of the false alarm masking rule. The value is fixed at 1, indicating the v2 version. v1 is only compatible with earlier versions where a rule cannot be created. |
| rule | Yes | String | Definition Rule to be masked. Constraints The options vary depending on the value of unchecked modules. Range Ignore WAF Protection
Default Value N/A |
| advanced | No | IgnoreAdvanced object | Advanced settings. |
| description | No | String | Rule description. |
| 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 |
| policyid | String | Policy ID |
| timestamp | Long | Timestamp the rule was created. |
| description | String | Rule Description |
| 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 |
| rule | String | Type or ID of the rule to be masked. |
| mode | Integer | The value is fixed at 1, indicating v2 false alarm masking rules are used. v1 is used only for compatibility with earlier versions, and false alarm rules cannot be created in v1. |
| conditions | Array of Condition objects | Condition list |
| multiCondition | Boolean | multiCondition |
| producer | Integer | Reference table source: 1 represents user creation, other values represent automatic generation by modulleX. |
| advanced | IgnoreAdvanced object | "Advanced settings. |
| domain | Array of strings | Protected domain name or website |
| Parameter | Type | Description |
|---|---|---|
| category | String | Field type. The value can be ip, url, params, cookie, or header. |
| contents | Array of strings | Content. The array length must be 1. The content format varies depending on field types. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be a URL in standard format. If the field type is params, cookie, or header, the content format is not limited. |
| logic_operation | String | Matching logics. The matching logic varies depending on field types. If the field type is ip, equal and not_equal are supported. If the field type is url, header, params, or cookie, equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix, regular_match, and regular_not_match are supported. |
| check_all_indexes_logic | Integer | If the field type is url or ip, the check_all_indexes_logic field does not exist. In other cases, the value 1 indicates that all subfields will be checked, the value 2 indicates that any subfield will be checked, and the valuenull indicates that custom subfields will be used. |
| index | String | If the field type is ip and the subfield is the client IP address, the index parameter does not exist. If the subfield type is X-Forwarded-For, the value is x-forwarded-for. If the field type is params, header, or cookie, and the subfield is user-defined, the value of index is the user-defined subfield. |
| Parameter | Type | Description |
|---|---|---|
| index | String | Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart. |
| contents | Array of strings | Subfield of the specified field type. The default value is all. |
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 global protection whitelist rule to them all at once.
POST https://{endpoint}/v1/{project_id}/waf/rule/ignore?enterprise_project_id=0
{
"domain" : [ "www.aaa.com" ],
"mode" : 1,
"description" : "ss",
"rule" : 1618,
"conditions" : [ {
"category" : "url",
"logic_operation" : "contain",
"index" : null,
"contents" : [ "dd" ]
} ],
"advanced" : {
"index" : "params",
"contents" : [ "sss" ]
},
"policy_ids" : [ "c467ec81836e4e9391102ad5e5949bb9" ]
} Example Responses
Status code: 200
Definition
OK
Constraints
N/A
Range
N/A
Default Value
N/A
{
"description" : "ss",
"rule" : 1618,
"mode" : 1,
"conditions" : [ {
"category" : "url",
"contents" : [ "dd" ],
"logic_operation" : "contain"
} ],
"producer" : 1,
"multiCondition" : false,
"domain" : [ "www.aaa.com" ],
"advanced" : {
"index" : "params",
"contents" : [ "sss" ]
}
} SDK Sample Code
The SDK sample code is as follows.
Select multiple policies and add a global protection 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 65 66 67 68 69 70 71 72 73 74 75 76 | 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 BatchCreateIgnoreRuleSolution { 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(); BatchCreateIgnoreRuleRequest request = new BatchCreateIgnoreRuleRequest(); BatchCreateIgnoreRuleRequestBody body = new BatchCreateIgnoreRuleRequestBody(); List<String> listbodyPolicyIds = new ArrayList<>(); listbodyPolicyIds.add("c467ec81836e4e9391102ad5e5949bb9"); List<String> listAdvancedContents = new ArrayList<>(); listAdvancedContents.add("sss"); IgnoreAdvanced advancedbody = new IgnoreAdvanced(); advancedbody.withIndex("params") .withContents(listAdvancedContents); List<String> listConditionsContents = new ArrayList<>(); listConditionsContents.add("dd"); List<CreateCondition> listbodyConditions = new ArrayList<>(); listbodyConditions.add( new CreateCondition() .withCategory(CreateCondition.CategoryEnum.fromValue("url")) .withLogicOperation(CreateCondition.LogicOperationEnum.fromValue("contain")) .withContents(listConditionsContents) ); List<String> listbodyDomain = new ArrayList<>(); listbodyDomain.add("www.aaa.com"); body.withPolicyIds(listbodyPolicyIds); body.withDescription("ss"); body.withAdvanced(advancedbody); body.withRule("1618"); body.withMode(1); body.withConditions(listbodyConditions); body.withDomain(listbodyDomain); request.withBody(body); try { BatchCreateIgnoreRuleResponse response = client.batchCreateIgnoreRule(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 global protection 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 | # 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 = BatchCreateIgnoreRuleRequest() listPolicyIdsbody = [ "c467ec81836e4e9391102ad5e5949bb9" ] listContentsAdvanced = [ "sss" ] advancedbody = IgnoreAdvanced( index="params", contents=listContentsAdvanced ) listContentsConditions = [ "dd" ] listConditionsbody = [ CreateCondition( category="url", logic_operation="contain", contents=listContentsConditions ) ] listDomainbody = [ "www.aaa.com" ] request.body = BatchCreateIgnoreRuleRequestBody( policy_ids=listPolicyIdsbody, description="ss", advanced=advancedbody, rule="1618", mode=1, conditions=listConditionsbody, domain=listDomainbody ) response = client.batch_create_ignore_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 global protection 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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | 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.BatchCreateIgnoreRuleRequest{} var listPolicyIdsbody = []string{ "c467ec81836e4e9391102ad5e5949bb9", } var listContentsAdvanced = []string{ "sss", } indexAdvanced:= "params" advancedbody := &model.IgnoreAdvanced{ Index: &indexAdvanced, Contents: &listContentsAdvanced, } var listContentsConditions = []string{ "dd", } var listConditionsbody = []model.CreateCondition{ { Category: model.GetCreateConditionCategoryEnum().URL, LogicOperation: model.GetCreateConditionLogicOperationEnum().CONTAIN, Contents: &listContentsConditions, }, } var listDomainbody = []string{ "www.aaa.com", } descriptionBatchCreateIgnoreRuleRequestBody:= "ss" request.Body = &model.BatchCreateIgnoreRuleRequestBody{ PolicyIds: listPolicyIdsbody, Description: &descriptionBatchCreateIgnoreRuleRequestBody, Advanced: advancedbody, Rule: "1618", Mode: int32(1), Conditions: listConditionsbody, Domain: listDomainbody, } response, err := client.BatchCreateIgnoreRule(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
