This API is used to query a precise protection rule.

Function

URI

GET /v1/edgesec/configuration/http/policies/{policy_id}/access-control-rule/{rule_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
policy_id	Yes	String	Policy ID.
rule_id	Yes	String	Protection rule ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	auth token

Response Parameters

Status code: 200

**Table 3** Response body parameters
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
time	Boolean	Whether to set the effective time
start	Long	Effective time
terminal	Long	Expiration time
priority	Integer	Priority
conditions	Array of HttpAccessControlRuleCondition objects	Hit condition.
action	HttpRuleAction object	Action of the protection rule.
producer	Integer	Source

**Table 4** HttpAccessControlRuleCondition
Parameter	Type	Description
category	String	Field type. The options are url, custom_asn, custom_geoip, robot, user-agent, ip, params, cookie, referer, header, method, request_line, request, response_code, response_length, response_time, response_header and response_body.
index	String	Subfield: If the field type is url, custom_asn, custom_geoip, robot, user-agent, referer, request_line, method, request, response_code, response_length, response_time or response_body, the index parameter does not need to be passed in. If the field type is params, cookie, header, or response_header and the subfield is customized, the index field is a customized subfield.
contents	Array of strings	Content list
logic_operation	String	Processing logic
value_list_id	String	ID of the reference table
size	Long	This field is used if the protection rule involves a threshold.
check_all_indexes_logic	Integer	All subfields/2. Any subfield

**Table 5** HttpRuleAction
Parameter	Type	Description
category	String	Operation type, block: block. pass: allow. log: Only log detected attacks.
followed_action_id	String	Attack punishment rule ID. This parameter is available only when category is set to block.
detail	HttpRuleActionDetail object	Action of the protection rule.

**Table 6** HttpRuleActionDetail
Parameter	Type	Description
redirect_url	String	URL to which the page is redirected.
response	HttpRuleActionResponse object	Return page of the protection rule

**Table 7** HttpRuleActionResponse
Parameter	Type	Description
content_type	String	Content type.
content	String	Content

Status code: 400

**Table 8** Response body parameters
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

**Table 9** Response body parameters
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

**Table 10** Response body parameters
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

query a precise protection rule

GET https://esa.cn-north-4.myhuaweicloud.com/v1/edgesec/configuration/http/policies/a7bd0ca4b2ac48cfb8c59deebf6b64e0/access-control-rule/a5bd0ca4b2ac48cfb8c59deebf6b64e8

Example Responses

Status code: 200

{
  "id" : "a5bd0ca4b2ac48cfb8c59deebf6b64e8",
  "name" : "access_control1",
  "policy_id" : "a7bd0ca4b2ac48cfb8c59deebf6b64e0",
  "policy_name" : "policy_test1",
  "timestamp" : 1731427500000,
  "description" : "test",
  "status" : 1,
  "time" : true,
  "start" : 1731423500000,
  "terminal" : 1731427900000,
  "priority" : 10,
  "conditions" : [ {
    "category" : "cookie",
    "index" : "test",
    "contents" : [ "aaa", "bbb" ],
    "logic_operation" : "contain"
  } ],
  "action" : {
    "category" : "block",
    "followed_action_id" : "a7bd0ca4b2ac48cfb8c59deebf6b64e1"
  },
  "producer" : 1
}