使用DescribeDomains API查詢CNAME接入的網域名稱列表-Web Application Firewall-阿里雲

查詢添加到 Web Application Firewall的網域名稱列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeDomains

get

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

無

yundun-waf:DescribeDomains

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體的 ID。說明您可以調用 DescribeInstance ，查看當前 WAF 執行個體的 ID。	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q
Domain	string	否	添加到 WAF 防護的網域名稱。	www.aliyundoc.com
Backend	string	否	網域名稱對應的來源站點伺服器 IP 或伺服器回源網域名稱。您只能選擇設定來源站點伺服器 IP 或伺服器回源網域名稱中的一種。	1.1.XX.XX
PageNumber	integer	否	分頁查詢時，返回第幾頁資料。預設值為 1，表示返回第 1 頁資料。	1
PageSize	integer	否	分頁查詢時，每頁包含多少條結果。預設值為 10，表示每頁包含 10 條結果。	10
DomainId	string	否	網域名稱 ID。	www.aliyundoc.com-waf
RegionId	string	否	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
Tag	array<object>	否	資源的標籤，最多支援 20 個子項。
	object	否	資源的標籤。
Key	string	否	標籤鍵。	TagKey1
Value	string	否	標籤值	TagValue1

返回參數

名稱	類型	描述	樣本值
	object	CNAME 接入列表。
RequestId	string	請求 ID。	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	integer	查詢到的網域名稱配置的總數量。	146
Domains	array<object>	CNAME 接入列表。
	array<object>	CNAME 接入詳情。
Domain	string	已接入 WAF 的網域名稱名稱。	www.aliyundoc.com
Status	integer	網域名稱狀態。取值： 1：表示網域名稱處於正常狀態。 2：表示網域名稱建立中。 3：表示網域名稱修改中。 4：表示網域名稱釋放中。 5：表示網域名稱停止轉寄。	1
Cname	string	WAF 為網域名稱分配的 CNAME 地址。	xxxxxcvdaf.****.com
ListenPorts	object	配置監聽資訊。
Http	array	HTTP 協議的監聽連接埠列表。
	integer	HTTP 協議的監聽連接埠。	80
Https	array	HTTPS 協議的監聽連接埠列表。
	integer	HTTPS 協議的監聽連接埠。	443
Backeds	object	回源配置資訊。
Http	array<object>	HTTP 協議回源地址清單。
	object	HTTP 協議回源地址。
Backend	string	HTTP 協議回源地址。	1.1.XX.XX
Https	array<object>	HTTPS 協議回源地址清單。
	object	HTTPS 協議回源地址。
Backend	string	HTTPS 協議回源地址。	1.1.XX.XX
ResourceManagerResourceGroupId	string	阿里雲資源群組 ID。	rg-acfmvtc5z52****
DomainId	string	網域名稱 ID。	www.aliyundoc.com-waf

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "DomainId": "www.aliyundoc.com-waf"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。