文档

DescribeCdnWafDomain - 查询WAF全量域名

更新时间:

调用DescribeCdnWafDomain查询WAF全量域名列表。

接口说明

说明 单用户调用频率:150 次/秒。

调试

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

授权信息

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

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

请求参数

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

WAF 管控区域。取值:

  • cn-hangzhou:WAF 中国内地(大陆)管控区域。
  • ap-southeast-1:WAF 非中国内地(大陆)管控区域。
说明 非中国内地(大陆)包含中国香港、中国澳门、中国台湾以及其他国家和地区。
cn-hangzhou
DomainNamestring

待查询的域名。

仅支持填写单个域名,详细见以下三种填写方式:

  • 填写精确域名:例如 example.com,则查询 example.com 域名的配置信息。
  • 填写关键字:例如 example,则查询所有包含 example 的域名配置信息。
  • 不填该参数:则默认返回所有开通了 WAF 的加速域名。
example.com
ResourceGroupIdstring

资源组 ID。

1234

返回参数

名称类型描述示例值
object
TotalCountinteger

加速域名的数量。

1
RequestIdstring

请求 ID。

CB1A380B-09F0-41BB-802B-72F8FD6DA2FE
OutPutDomainsarray<object>

加速域名信息。

object
AclStatusstring

ACL 状态。取值:

  • 0:关闭。
  • 1:开通。
1
Statusstring

WAF 域名状态。取值:

  • 1:WAF 域名创建成功或 WAF 域名有效。
  • 10:WAF 域名创建中。
  • 11:WAF 域名创建失败。
1
Domainstring

域名信息。

example.com
CcStatusstring

CC 状态。取值:

  • 0:关闭。
  • 1:开通。
1
WafStatusstring

WAF 状态。取值:

  • 0:关闭。
  • 1:开通。
1

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "CB1A380B-09F0-41BB-802B-72F8FD6DA2FE",
  "OutPutDomains": [
    {
      "AclStatus": "1",
      "Status": "1",
      "Domain": "example.com",
      "CcStatus": "1",
      "WafStatus": "1"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400InvalidParameterInvalidParameter.
400InvalidParameterRegionIdInvalid Region ID.
400InvalidParameterDomainInvalid Domain Name.
400DomainNotExist Specified Domain Not Exist.

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