调用DescribeDomainBasicConfigs查询已接入WAF防护的网站域名的基本配置。

使用说明

本接口用于分页查询已接入WAF防护的网站域名的基本配置(以下简称域名配置),例如,域名配置的状态、默认防护模块(包括规则防护引擎、CC安全防护、自定义防护策略)的状态和模式等。

QPS限制

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

调试

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

请求参数

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

要执行的操作。取值:DescribeDomainBasicConfigs

InstanceId String waf-cn-tl32ast****

WAF实例的ID。

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

设置域名关键字,查询包含指定关键字的域名配置。

不设置该参数表示查询所有域名配置。

AccessType String waf-cloud-dns

设置域名接入模式,查询使用指定方式接入WAF防护的域名配置。取值:

  • waf-cloud-dns:表示CNAME接入。
  • waf-cloud-native:表示透明接入。

不设置该参数表示查询所有域名配置。

CloudNativeProductId Integer 0

设置源站类型,查询在透明接入方式下通过指定源站类型接入WAF防护的域名配置。取值:

  • 0:表示云服务器ECS实例。
  • 1:表示传统型负载均衡CLB实例。
  • 2:表示应用型负载均衡ALB实例。

不设置该参数表示查询所有域名配置。

PageNumber Integer 1

分页查询时,设置当前页面的页码。默认值为1

PageSize Integer 10

分页查询时,设置每页包含域名配置的数量。默认值为10

ResourceGroupId String rg-acfm2pz25js****

网站域名在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

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

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

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

查询到的域名配置的总数量。

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

本次请求的ID。

DomainConfigs Array of DomainConfig

域名配置详情列表。

Status Integer 1

域名配置的状态。取值:

  • 0:表示无效(已删除)。
  • 1:表示有效(创建成功)。
  • 10:表示创建中。
  • 11:表示创建失败。
  • 20:表示删除中。
Domain String www.aliyundoc.com

域名。

Owner String WAF

域名配置的来源。取值固定为WAF,表示通过Web应用防火墙服务添加。

CcMode Integer 0

CC安全防护功能的模式。取值:

  • 0:表示防护模式。
  • 1:表示防护-紧急模式。
CcStatus Integer 1

CC安全防护功能的状态。取值:

  • 0:表示关闭。
  • 1:表示开启。
AccessType String waf-cloud-dns

域名接入模式。取值:

  • waf-cloud-dns:表示CNAME接入。
  • waf-cloud-native:表示透明接入。
Version Long 0

当前配置的版本号。

AclStatus Integer 1

自定义防护策略功能的状态。取值:

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

规则防护引擎功能的状态。取值:

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

规则防护引擎功能的模式。取值:

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDomainBasicConfigs
&InstanceId=waf-cn-tl32ast****
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

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

<DescribeDomainBasicConfigsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <DomainConfigs>
        <Status>1</Status>
        <Domain>www.aliyundoc.com</Domain>
        <Owner>WAF</Owner>
        <CcMode>0</CcMode>
        <CcStatus>1</CcStatus>
        <Version>0</Version>
        <AclStatus>1</AclStatus>
        <WafStatus>1</WafStatus>
        <WafMode>0</WafMode>
    </DomainConfigs>
</DescribeDomainBasicConfigsResponse>

JSON格式

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

{
  "TotalCount" : 1,
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainConfigs" : [ {
    "Status" : 1,
    "Domain" : "www.aliyundoc.com",
    "Owner" : "WAF",
    "CcMode" : 0,
    "CcStatus" : 1,
    "Version" : 0,
    "AclStatus" : 1,
    "WafStatus" : 1,
    "WafMode" : 0
  } ]
}

错误码

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