调用DescribeDcdnWafRule获取指定防护规则详细信息。

使用说明

单用户调用频率:20次/秒。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDcdnWafRule

系统规定参数。取值:DescribeDcdnWafRule

RuleId Long 1000001

防护规则ID,仅支持单个输入。

返回数据

名称 类型 示例值 描述
RequestId String 66A98669-CC6E-4F3E-80A6-3014697B11AE

请求ID。

Rule Object

防护规则信息。

RuleStatus String on

防护规则状态,取值:

  • on:开启
  • off:关闭
DefenseScene String custom_acl

防护策略类型,目前支持以下场景:

  • waf_group:Web基础防护
  • custom_acl:自定义防护策略
  • whitelist:白名单
PolicyId Long 200001

防护策略ID。

GmtModified String 2021-12-29T17:08:45Z

修改时间。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

RuleId Long 100001

防护规则ID。

RuleName String rule_1

防护规则名称。

RuleConfig String {\"action\":\"monitor\",\"actionExternal\":\"{}\",\"ccStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"eq\",\"targetKey\":\"request_uri\",\"values\":\"/example\"},{\"key\":\"Header\",\"opValue\":\"eq\",\"subKey\":\"trt\",\"targetKey\":\"header.trt\",\"values\":\"3333\"}],\"effect\":\"service\",\"name\":\"aaa333\",\"origin\":\"custom\",\"ratelimit\":{\"interval\":5,\"status\":{\"code\":404,\"count\":2,\"stat\":{\"mode\":\"count\",\"value\":2.0}},\"target\":\"remote_addr\",\"threshold\":2,\"ttl\":1800}}

防护规则配置。

示例

请求示例

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnWafRule
&RuleId=1000001
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnWafRuleResponse>
    <Rule>
        <GmtModified>2021-12-29T17:08:45Z</GmtModified>
        <PolicyId>200001</PolicyId>
        <RuleId>100001</RuleId>
        <RuleName>rule_1</RuleName>
        <RuleStatus>on</RuleStatus>
        <RuleConfig>{"action":"monitor","actionExternal":"{}","ccStatus":1,"conditions":[{"key":"URL","opValue":"eq","targetKey":"request_uri","values":"/example"},{"key":"Header","opValue":"eq","subKey":"trt","targetKey":"header.trt","values":"3333"}],"effect":"service","name":"aaa333","origin":"custom","ratelimit":{"interval":5,"status":{"code":404,"count":2,"stat":{"mode":"count","value":2.0}},"target":"remote_addr","threshold":2,"ttl":1800}}</RuleConfig>
        <DefenseScene>custom_acl</DefenseScene>
    </Rule>
    <RequestId>66A98669-CC6E-4F3E-80A6-3014697B11AE</RequestId>
</DescribeDcdnWafRuleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Rule" : {
    "GmtModified" : "2021-12-29T17:08:45Z",
    "PolicyId" : 200001,
    "RuleId" : 100001,
    "RuleName" : "rule_1",
    "RuleStatus" : "on",
    "RuleConfig" : "{\"action\":\"monitor\",\"actionExternal\":\"{}\",\"ccStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"eq\",\"targetKey\":\"request_uri\",\"values\":\"/example\"},{\"key\":\"Header\",\"opValue\":\"eq\",\"subKey\":\"trt\",\"targetKey\":\"header.trt\",\"values\":\"3333\"}],\"effect\":\"service\",\"name\":\"aaa333\",\"origin\":\"custom\",\"ratelimit\":{\"interval\":5,\"status\":{\"code\":404,\"count\":2,\"stat\":{\"mode\":\"count\",\"value\":2.0}},\"target\":\"remote_addr\",\"threshold\":2,\"ttl\":1800}}",
    "DefenseScene" : "custom_acl"
  },
  "RequestId" : "66A98669-CC6E-4F3E-80A6-3014697B11AE"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The specified parameter is invalid. 无效的参数值。

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