Queries the accurate access control rules that are created for websites.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeWebPreciseAccessRule

The operation that you want to perform. Set the value to DescribeWebPreciseAccessRule.

Domains.N RepeatList Yes www.aliyun.com

The domain name of website N.

Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

Response parameters

Parameter Type Example Description
PreciseAccessConfigList Array

The configuration of the accurate access control rule that is created for the website.

Domain String www.aliyun.com

The domain name of the website.

RuleList Array

Details about the accurate access control rule.

Action String accept

The action performed if the rule is matched. Valid values:

  • accept
  • block
  • challenge
ConditionList Array

The match conditions.

Content String 1.1.1.1

The match content.

Field String ip

The match field.

HeaderName String null

The custom HTTP header.

Note This parameter is returned only when the Field parameter is header.
MatchMethod String belong

The logical relation.

Expires Long 0

The validity period of the rule. Unit: seconds. This parameter only takes effect when theAction parameter of a rule is block. Access requests that hit the rule are blocked within the specified validity period of the rule.0 indicates that the rule takes effect all the time.

Name String testrule

The name of the rule.

Owner String manual

The mode of how the rule was created. Valid values:

  • manual: manually created
  • auto: automatically generated
RequestId String 209EEFBF-B0C7-441E-8C28-D0945A57A638

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeWebPreciseAccessRule
&Domains.1=www.aliyun.com
&<Common request parameters>

Sample success responses

XML format

<DescribeWebPreciseAccessRuleResponse>
      <PreciseAccessConfigList>
            <RuleList>
                  <Owner>manual</Owner>
                  <Action>accept</Action>
                  <ConditionList>
                        <MatchMethod>belong</MatchMethod>
                        <Field>ip</Field>
                        <HeaderName></HeaderName>
                        <Content>1. ***. ***.2</Content>
                  </ConditionList>
                  <Expires>0</Expires>
                  <Name>testrule</Name>
            </RuleList>
            <Domain>www.aliyun.com</Domain>
      </PreciseAccessConfigList>
      <RequestId>209EEFBF-B0C7-441E-8C28-D0945A57A638</RequestId>
</DescribeWebPreciseAccessRuleResponse>

JSON format

{
    "PreciseAccessConfigList": [
        {
            "RuleList": [
                {
                    "Owner": "manual",
                    "Action": "accept",
                    "ConditionList": [
                        {
                            "MatchMethod": "belong",
                            "Field": "ip",
                            "HeaderName": "",
                            "Content": "1. ***. ***.2"
                        }
                    ],
                    "Expires": 0,
                    "Name": "testrule"
                }
            ],
            "Domain": "www.aliyun.com"
        }
    ],
    "RequestId": "209EEFBF-B0C7-441E-8C28-D0945A57A638"
}

Error codes

For a list of error codes, visit the API Error Center.