DescribeWebPreciseAccessRule - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the precise access control rules for a website.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddoscoo:DescribeWebPreciseAccessRule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs. If you leave this parameter empty, the instance belongs to the default resource group.	default
Domains	array	Yes	The domain name of the website. Note A website forwarding rule must be configured for the domain name. Call DescribeDomains to query all domain names.	www.aliyun.com
	string	No	The domain name of the website.	www.test****.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	209EEFBF-B0C7-441E-8C28-D0945A57A638
PreciseAccessConfigList	array<object>	The precise access control rules for the website.
	array<object>
Domain	string	The domain name of the website.	www.aliyun.com
RuleList	array<object>	The list of rules.
	array<object>
Action	string	The action that is performed on a matched request. Valid values: accept: allows the request. block: blocks the request. challenge: triggers a JavaScript Challenge.	accept
Owner	string	The source of the rule. Valid values: manual: The rule is manually created. This is the default value. auto: The rule is automatically generated.	manual
Expires	integer	The validity period of the rule, in seconds. This parameter takes effect only when Action is set to block. Within the validity period, matched requests are blocked. A value of 0 indicates that the rule is permanently valid.	0
Name	string	The name of the rule.	testrule
ConditionList	array<object>	The list of match conditions.
	object
MatchMethod	string	The logical operator.	belong
Field	string	The match field.	ip
Content	string	The match content.	1.1.1.1
HeaderName	string	The name of the custom HTTP header field. Note This parameter is valid only when Field is set to header.	null
ContentList	array
	string

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.