DescribeDomainRuleGroup - DescribeDomainRuleGroup

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

接口说明

本接口用于查询规则防护引擎下,指定域名绑定的防护规则组的 ID 及智能规则托管功能的启用状态。 请注意,为了确保系统的文档性,对单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:DescribeDomainRuleGroupRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Domainstring

要查询的域名。

说明 您可以调用 DescribeDomainList 查询所有已接入 WAF 防护的域名。
www.aliyundoc.com
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
waf-cn-tl32ast****
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。默认为空,即属于默认资源组。

关于资源组的更多信息,请参见创建资源组

rg-aek2oij****hbfi
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

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

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

返回参数

名称类型描述示例值
object
RuleGroupIdlong

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

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

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

1012
RequestIdstring

本次请求的 ID。

D7861F61-5B61-46CE-A47C-6B19160D5EB0
WafAiStatusinteger

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

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

示例

正常返回示例

JSON格式

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

错误码

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