This API is used to query false alarm masking rules.
Function
This API is used to query false alarm masking rules.
URI
GET /v1/edgesec/configuration/http/policies/{policy_id}/ignore-rule
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
policy_id |
Yes |
String |
Policy ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status |
No |
Integer |
Rule enabling status |
page |
No |
Integer |
Page number, which is required for pagination query. |
pagesize |
No |
Integer |
Pagination query parameter. The number of records displayed on each page is specified by pagesize. |
rule |
No |
String |
Undetected module type |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
auth token |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Number of protection rules in a policy |
items |
Array of ShowHttpIgnoreRuleResponseBody objects |
Protection rule list |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID |
name |
String |
Rule name |
policy_id |
String |
ID of the policy to which the rule belongs |
policy_name |
String |
Name of the policy to which the rule belongs |
timestamp |
Long |
Time when a rule is created |
description |
String |
Rule description |
status |
Integer |
Rule enabling status |
url |
String |
URL of the false alarm |
rule |
String |
Rule No. |
mode |
Integer |
False alarm masking mode. The default value is 0, indicating the old mode. |
domains |
Array of strings |
Domain name list |
url_logic |
String |
URL type of the masking rule (prefix or equal) |
advanced |
HttpIgnoreRuleCondition object |
The parameters in the condition list are complex and are cascaded. Add a false alarm masking rule on the console. Press F12 to view the request parameters whose path suffix is /ignore-rule and method is POST. |
conditions |
Array of HttpIgnoreRuleCondition objects |
Hit condition |
hit_num |
Integer |
Hit count |
update_time |
Long |
Timestamp for the last update |
clear_time |
Long |
Timestamp for clearing the last hit count |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Field type. The value can be ip, url, params, cookie, or header. |
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, set the value to x-forwarded-for. If the field type is params, header, or cookie and the subfield is of a customized type, the value of index is the custom subfield. |
contents |
Array of strings |
Content list |
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. |
value_list_id |
String |
ID of the referenced table |
size |
Long |
This field is used if the protection rule involves a threshold. |
check_all_indexes_logic |
Integer |
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Standard error code: service name.8-digit code |
error_msg |
String |
Detailed error information. |
encoded_authorization_message |
String |
If the service is integrated with IAM5.0, an IAM response must be returned when access is denied. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Standard error code: service name.8-digit code |
error_msg |
String |
Detailed error information. |
encoded_authorization_message |
String |
If the service is integrated with IAM5.0, an IAM response must be returned when access is denied. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Standard error code: service name.8-digit code |
error_msg |
String |
Detailed error information. |
encoded_authorization_message |
String |
If the service is integrated with IAM5.0, an IAM response must be returned when access is denied. |
Example Requests
None
Example Responses
None
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