調(diào)用DescribeDomainList分頁查詢已添加到WAF防護的域名列表。
接口說明
本接口也可以用于查詢已添加到 WAF 防護的所有域名,但是不支持分頁查詢(即只能一次性返回所有域名)。對于域名數(shù)量較多的場景,推薦您調(diào)用該接口進行分頁查詢(分頁顯示結(jié)果并支持按條件查詢)。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceGroupId | string | 否 | WAF 實例在資源管理服務(wù)中所屬的資源組 ID。默認(rèn)為空,即屬于默認(rèn)資源組。 關(guān)于資源組的更多信息,請參見創(chuàng)建資源組。 | rg-acfm2pz25js**** |
InstanceId | string | 是 | WAF 實例的 ID。 說明
您可以調(diào)用 DescribeInstanceInfo ,查看當(dāng)前 WAF 實例的 ID。
| waf-cn-7pp26f1**** |
DomainName | string | 否 | 要查詢的域名名稱。 您可以設(shè)置該參數(shù),前綴匹配某個域名是否已接入 WAF 防護。 | example.com |
PageNumber | integer | 否 | 分頁查詢時,返回第幾頁數(shù)據(jù)。默認(rèn)值為 1,表示返回第 1 頁數(shù)據(jù)。 | 1 |
PageSize | integer | 否 | 分頁查詢時,每頁包含多少條結(jié)果。默認(rèn)值為 10,表示每頁包含 10 條結(jié)果。 | 10 |
IsSub | integer | 否 | 要查詢的域名類型。取值:
| 0 |
DomainNames | array | 否 | 要查詢的域名列表。 您可以設(shè)置該參數(shù),模糊查詢多個域名是否已接入 WAF 防護。 | |
string | 否 | 要查詢的域名。 | example.com | |
RegionId | string | 否 | WAF 實例所屬地域。取值:
| cn-hangzhou |
調(diào)用 API 時,除了本文中該 API 的請求參數(shù),還需加入阿里云 API 公共請求參數(shù)。公共請求參數(shù)的詳細(xì)介紹,請參見公共參數(shù)。
調(diào)用 API 的請求格式,請參見本文示例中的請求示例。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"TotalCount": 2,
"RequestId": "592E866F-6C05-4E7C-81DE-B4D8E86B91EF",
"DomainNames": [
"www.example.com"
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。