DescribeWebPreciseAccessRule - 查询网站业务精确访问控制规则 - DDoS 防护

查询网站业务精确访问控制规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-ddoscoo:DescribeWebPreciseAccessRule

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	否	DDoS 高防实例在资源管理产品中所属的资源组 ID。默认为空，即属于默认资源组。	default
Domains	array	是	网站业务的域名。说明域名必须已配置网站业务转发规则。您可以调用 DescribeDomains 查询所有域名。	www.aliyun.com
	string	否	网站业务的域名。	www.test****.com
Owner	string	否	筛选规则来源。取值： manual（默认）：手动添加 clover：自动生成	manual

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	209EEFBF-B0C7-441E-8C28-D0945A57A638
PreciseAccessConfigList	array<object>	网站业务精确访问控制规则。
	array<object>
Domain	string	网站域名。	www.aliyun.com
RuleList	array<object>	规则列表。
	array<object>
Action	string	匹配动作。取值： accept：放行 block：封禁 challenge：挑战	accept
Owner	string	规则来源。取值： manual：手动添加（默认） clover：自动生成	manual
ExpirePeriod	integer	规则有效期时间戳。单位：秒。	1598889600
Name	string	规则名称。	testrule
ConditionList	array<object>	匹配条件列表。
	object
MatchMethod	string	逻辑符。	belong
Field	string	匹配字段。	ip
Content	string	匹配内容。	1.1.1.1
HeaderName	string	自定义 HTTP 头部字段名称。说明仅在 Field 为 header 时有效。	null
ContentList	array	规则的匹配条件。具体结构如下。说明如果设置了多个匹配条件，则多个条件间是且的关系。 field：String 类型，匹配字段。 match_method：String 类型，匹配方法。说明关于 field 和match_method的取值，请参见请求参数表下的补充描述。 content：String 类型，匹配内容。 header_name：String 类型，头部字段名称。仅在 field 为 header 时生效。
	string	匹配的条件。	{"field":"uri","match_method":"contain","content":"/test/123"}
Expires	integer	规则有效期。单位：秒。规则的匹配动作为阻断时（action 为 block）生效，在规则有效期内阻断访问请求。0 表示永久生效。	0

field 和 match_method 的取值及对应关系

匹配字段（field）	描述	适用的逻辑符（match_method）
ip	访问请求的来源 IP。	belong ：属于 nbelong ：不属于
uri	访问请求的 URI 地址。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于 regular ：正则匹配
referer	访问请求的来源网址，即该访问请求是从哪个页面跳转产生的。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于 nexist ：不存在 regular ：正则匹配
user-agent	发起访问请求的客户端的浏览器标识、渲染引擎标识和版本信息等浏览器相关信息。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于 regular ：正则匹配
params	访问请求的 URL 地址中的参数部分，通常指 URL 中”?”后面的部分。例如，`demo.aliyundoc.com/index.html?action=login`中的`action=login`就是参数部分。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于
cookie	访问请求中的 Cookie 信息。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于 nexist ：不存在
content-type	访问请求指定的响应 HTTP 内容类型，即 MIME 类型信息。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于
x-forwarded-for	访问请求的客户端真实 IP。X-Forwarded-For（XFF）用来识别通过 HTTP 代理或负载均衡方式转发的访问请求的客户端最原始的 IP 地址的 HTTP 请求头字段，只有通过 HTTP 代理或者负载均衡服务器转发的访问请求才会包含该项。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于 nexist ：不存在 regular ：正则匹配
content-length	访问请求的所包含的字节数。	vless ：值小于 vequal ：值等于 vgreat ：值大于
post-body	访问请求的内容信息。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 regular ：正则匹配
http-method	访问请求的方法，如 GET、POST 等。	equal ：等于 nequal ：不等于
header	访问请求的头部信息，用于自定义 HTTP 头部字段。	contain ：包含 ncontain ：不包含 equal ：等于 nequal ：不等于 lless ：长度小于 lequal ：长度等于 lgreat ：长度大于 nexist ：不存在

示例

正常返回示例

JSON格式

{
  "RequestId": "209EEFBF-B0C7-441E-8C28-D0945A57A638",
  "PreciseAccessConfigList": [
    {
      "Domain": "www.aliyun.com",
      "RuleList": [
        {
          "Action": "accept",
          "Owner": "manual",
          "ExpirePeriod": 1598889600,
          "Name": "testrule",
          "ConditionList": [
            {
              "MatchMethod": "belong",
              "Field": "ip",
              "Content": "1.1.1.1",
              "HeaderName": "null",
              "ContentList": [
                "{\"field\":\"uri\",\"match_method\":\"contain\",\"content\":\"/test/123\"}"
              ]
            }
          ],
          "Expires": 0
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。