Querying Global Protection Whitelist (Formerly False Alarm Masking) Rules
Function
Querying Global Protection Whitelist (Formerly False Alarm Masking) Rules
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/ignore
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. To query resources associated with all enterprise projects in the current account, specify parameter all_granted_eps. |
page |
No |
Integer |
Page number of the data to be returned during pagination query. The default value is 1, indicating that the data on the first page is returned. |
pagesize |
No |
Integer |
Number of results on each page during pagination query. Value range: 1 to 100. The default value is 10, indicating that each page contains 10 results. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
Content type. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
The number of global protection whitelist (formerly false alarm masking) rules in the protection policy. |
items |
Array of IgnoreRuleBody objects |
Domain names the global protection whitelist (formerly false alarm masking) rule is used for. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID |
policyid |
String |
ID of the protection policy that includes the rule |
timestamp |
Long |
Timestamp the rule was created. |
description |
String |
Rule description |
status |
Integer |
Rule status. The value can be 0 or 1. |
url |
String |
The path for false masking alarms. This parameter is available only when mode is set to 0. |
rule |
String |
Rules to be masked
xss: XSS attacks webshell: Web shells vuln: Other types of attacks sqli: SQL injection attack robot: Malicious crawlers rfi: Remote file inclusion lfi: Local file inclusion cmdi: Command injection attack |
mode |
Integer |
Version number. 0: indicates the old version V1. 1: indicates the new version V2. If the value of mode is 0, the conditions and multi_conditions fields do not exist, and the url and url_logic fields exist. If the value of mode is 1, the url and url_logic fields do not exist, and either the conditions field or the multi_conditions field exists. This is determined by the actual results returned. |
url_logic |
String |
Matching logic. The value can be equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix. |
conditions |
Array of Condition objects |
Condition list |
domain |
Array of strings |
Protecting Domain Names or Protecting Websites |
advanced |
IgnoreAdvanced object |
Advanced settings. |
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 |
The matching logic varies depending on the field type. For example, if the field type is ip, the logic can be equal or not_equal. If the field type is url, params, cookie, or header, the logic can be equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix. |
check_all_indexes_logic |
Integer |
This parameter is reserved and can be ignored. |
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: 403
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Example Requests
The following example shows how to query the global whitelist protect (the formerly false alarm masking) rule list. Details about the query are specified by project_id and policy_id.
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0&page=1&pagesize=10
Example Responses
Status code: 200
OK
{ "total" : 1, "items" : [ { "id" : "40484384970948d79fffe4e4ae1fc54d", "policyid" : "f385eceedf7c4c34a4d1def19eafbe85", "timestamp" : 1650512535222, "description" : "demo", "status" : 1, "rule" : "091004", "mode" : 1, "conditions" : [ { "category" : "ip", "contents" : [ "x.x.x.x" ], "logic_operation" : "equal" } ], "domain" : [ "we.test.418lab.cn" ] } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Request failed. |
401 |
The token does not have required permissions. |
403 |
Insufficient resource quota. |
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