全部产品
Search

搜索本产品

    Web 应用防火墙：DescribeDomainBasicConfigs - 获取域名配置记录的防护设置状态

    文档中心

    Web 应用防火墙：DescribeDomainBasicConfigs - 获取域名配置记录的防护设置状态

    更新时间：Jun 27, 2024

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

    接口说明

    本接口用于分页查询已接入 WAF 防护的网站域名的基本配置（以下简称域名配置），例如，域名配置的状态、默认防护模块（包括规则防护引擎、CC 安全防护、自定义防护策略）的状态和模式等。请注意，为确保系统稳定性，对单用户 QPS 限制为 50 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    WAF 实例的 ID。

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

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

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

    		aliyundoc
    AccessTypestring否

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

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

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

    		waf-cloud-dns
    CloudNativeProductIdinteger否

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

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

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

    		0
    PageNumberinteger否

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

    		1
    PageSizeinteger否

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

    		10
    ResourceGroupIdstring否

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

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

    		rg-acfm2pz25js****
    RegionIdstring否

    WAF 实例所属地域。取值：

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

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

    		cn-hangzhou

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

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

    返回参数

    名称类型描述示例值
    object
    TotalCountinteger

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

    		1
    RequestIdstring

    本次请求的 ID。

    		D7861F61-5B61-46CE-A47C-6B19160D5EB0
    DomainConfigsobject []

    域名配置详情列表。

    Statusinteger

    域名配置的状态。取值：

    • 0：表示无效（已删除）。
    • 1：表示有效（创建成功）。
    • 10：表示创建中。
    • 11：表示创建失败。
    • 20：表示删除中。
    		1
    Domainstring

    域名。

    		www.aliyundoc.com
    Ownerstring

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

    		WAF
    CcModeinteger

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

    • 0：表示防护模式。
    • 1：表示防护-紧急模式。
    		0
    CcStatusinteger

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

    • 0：表示关闭。
    • 1：表示开启。
    		1
    AccessTypestring

    域名接入模式。取值：

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

    当前配置的版本号。

    		0
    AclStatusinteger

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

    • 0：表示关闭。
    • 1：表示开启。
    		1
    WafStatusinteger

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

    • 0：表示关闭。
    • 1：表示开启。
    		1
    WafModeinteger

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

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

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息
    403ForbbidenUser not authorized to operate on the specified resource.
    500InternalErrorThe request processing has failed due to some unknown error.

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