调用DescribeDomainRuleGroup查询域名绑定的防护规则组的ID及智能规则托管功能的启用状态。

使用说明

本接口用于查询规则防护引擎下,指定域名绑定的防护规则组的ID及智能规则托管功能的启用状态。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

请求参数

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

要执行的操作。取值:DescribeDomainRuleGroup

Domain String www.aliyundoc.com

要查询的域名。

说明 您可以调用DescribeDomainList查询所有已接入WAF防护的域名。
InstanceId String waf-cn-tl32ast****

WAF实例的ID。

说明 您可以调用DescribeInstanceInfo查询当前WAF实例的ID。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RuleGroupId Long 1012

域名绑定的防护规则组的ID。取值:

  • 1011:表示WAF内置的严格规则组。
  • 1012:表示WAF内置的中等规则组。
  • 1013:表示WAF内置的宽松规则组。

其他取值表示您自定义的规则组的ID。

RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

本次请求的ID。

WafAiStatus Integer 1

智能规则托管功能的启用状态。取值:

  • 0:表示关闭。
  • 1:表示开启。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDomainRuleGroup
&Domain=www.aliyundoc.com
&InstanceId=waf-cn-tl32ast****
&公共请求参数

正常返回示例

XML格式

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

<DescribeDomainRuleGroupResponse>
    <RuleGroupId>1012</RuleGroupId>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <WafAiStatus>1</WafAiStatus>
</DescribeDomainRuleGroupResponse>

JSON格式

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

{
  "RuleGroupId" : 1012,
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "WafAiStatus" : 1
}

错误码

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