Queries the ID of the protection rule group of the protection rules engine feature and the status of the intelligent rule hosting feature for a specific domain name.

Usage notes

You can call the DescribeDomainRuleGroup operation to query the ID of the protection rule group of the protection rules engine feature and the status of the intelligent rule hosting feature for a specific domain name.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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 DescribeDomainRuleGroup

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

Domain String Yes www.aliyundoc.com

The domain name that you want to query.

Note You can call the DescribeDomainList operation to query all domain names that are protected by Web Application Firewall (WAF).
InstanceId String Yes waf-cn-tl32ast****

The ID of the WAF instance.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RuleGroupId Long 1012

The ID of the protection rule group that is bound to the domain name. Valid values:

  • 1011: the built-in strict rule group
  • 1012: the built-in medium rule group
  • 1013: the built-in loose rule group

Other values indicate the ID of your custom rule group.

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

The ID of the request.

WafAiStatus Integer 1

The status of the intelligent rule hosting feature. Valid values:

  • 0: disabled
  • 1: enabled

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainRuleGroup
&Domain=www.aliyundoc.com
&InstanceId=waf-cn-tl32ast****
&Common request parameters

Sample success responses

XML format 

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 format 

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

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

Error codes

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