文档

DescribeProtectionModuleMode - 获取域名当前的防护模式

获取指定域名配置当前的防护模式,如正则防护引擎、大数据深度学习引擎、CC安全防护、数据风控、主动防御。

接口说明

本接口用于查询网站防护配置中,指定防护模块(包括规则防护引擎、深度学习引擎、CC 安全防护、数据风控、主动防御)当前使用的防护模式。 您可以通过设置 DefenseType 参数值指定要查询的防护模块。具体参数值的含义,请参见请求参数 DefenseType 的描述。 调用接口前,您必须已经调用 CreateDomain 创建了网站接入配置,将网站域名接入 WAF 防护。 请注意,为了确保系统的文档性,对单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

要查询的网站域名。

说明 网站域名必须已经接入 WAF 防护。您可以调用 DescribeDomainList 查询所有已接入 WAF 防护的网站域名。
www.aliyundoc.com
DefenseTypestring

要查询其模式的防护模块。取值:

  • waf:表示规则防护引擎。
  • dld:表示深度学习引擎。
  • ac_cc:表示 CC 安全防护。
  • antifraud:表示数据风控。
  • normalized:表示主动防御。
waf
InstanceIdstring

WAF 实例的 ID。

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

网站域名在资源管理服务中所属的资源组 ID。不设置该参数表示默认资源组。

rg-atstuj3rtop****

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

DE14845A-F46F-59BE-B8F7-6ED7A787D213
Modeinteger

防护模块当前使用的防护模式。根据请求参数 DefenseType 不同,该参数的取值和含义不同,具体说明如下:

  • DefenseTypewaf(表示查询规则防护引擎),Mode 取值:

    • 0:表示拦截模式。
    • 1:表示告警模式。
  • DefenseTypedld(表示查询深度学习引擎),Mode 取值:

    • 0:表示告警模式。
    • 1:表示拦截模式。
  • DefenseTypeac_cc(表示查询 CC 安全防护模块),Mode 取值:

    • 0:表示防护模式。
    • 1:表示防护-紧急模式。
  • DefenseTypeantifraud(表示查询数据风控模块),Mode 取值:

    • 0:表示告警模式。
    • 1:表示拦截模式。
    • 2:表示强拦截模式。
  • DefenseTypenormalized(表示查询主动防御模块),Mode 取值:

    • 0:表示告警模式。
    • 1:表示拦截模式。
0

示例

正常返回示例

JSON格式

{
  "RequestId": "DE14845A-F46F-59BE-B8F7-6ED7A787D213",
  "Mode": 0
}

错误码

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