DescribeUserDomains - 查詢使用者網域名稱 -

調用DescribeUserDomains查詢使用者名稱下所有的網域名稱與狀態，支援網域名稱模糊比對過濾和網域名稱狀態過濾。

介面說明

單使用者調用頻率：100 次/秒。
支援批量查詢網域名稱，多個網域名稱用半形逗號（,）分隔，一次最多支援 50 個網域名稱查詢。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cdn:DescribeUserDomains

get

*Domain

acs:cdn:*:{#accountId}:domain/*

無

請求參數

名稱	類型	必填	描述	樣本值
PageSize	integer	否	分頁大小，取值1~500，預設值為 20，最大值為 500。	5
PageNumber	integer	否	取得第幾頁，取值範圍：1~100000。	1
DomainName	string	否	加速網域名稱。如果不傳該參數，預設不做網域名稱匹配搜尋，返回所有合格網域名稱。	example.com
DomainStatus	string	否	網域名稱狀態過濾。取值： online：啟用。 offline：停用。 configuring：配置中。 configure_failed：配置失敗。 checking：正在審核。 check_failed：審核失敗。 stopping：停用中。 deleting：刪除中。如果不傳該參數，預設查詢所有狀態。	configure_failed
DomainSearchType	string	否	網域名稱查詢類型。取值： fuzzy_match：模糊比對。 pre_match：前匹配。 suf_match：後匹配。 full_match（預設值）：完全符合。說明傳遞了網域名稱參數的情況下，不傳 DomainSearchType 參數，則預設採用完全符合模式。	fuzzy_match
CdnType	string	否	CDN 業務類型，多個用半形逗號（,）分隔。取值： web：圖片小檔案。 download：大檔案下載。 video：視音頻點播。如果不傳該參數，預設查詢所有業務類型。	download,web,video
CheckDomainShow	boolean	否	是否展示審核中、審核失敗、配置失敗的網域名稱。取值： true：是。 false：否。	false
ResourceGroupId	string	否	資源群組 ID，預設查詢所有資源群組 ID。	abcd1234abcd1234
ChangeStartTime	string	否	更新開始時間，使用 UTC+0 時間表示，格式為 yyyy-MM-ddTHH:mm:ssZ。	2019-10-10T12:14:55Z
ChangeEndTime	string	否	更新結束時間，使用 UTC+0 時間表示，格式為 yyyy-MM-ddTHH:mm:ssZ。說明結束時間需晚於起始時間。	2019-10-10T12:14:58Z
Coverage	string	否	加速地區，預設為全部地區。取值： domestic：僅中國內地。 global：全球。 overseas：全球（不包含中國內地）。	domestic
Source	string	否	來源站點資訊。	***
Tag	array<object>	否	標籤列表。列表元素最大數量：20。
	object	否	標籤解釋。
Key	string	否	標籤鍵。預設查詢所有標籤鍵。	key
Value	string	否	標籤值。預設查詢所有標籤值。	value

返回參數

名稱	類型	描述	樣本值
	object	參數解釋。
RequestId	string	請求 ID。	BDA62CE4-3477-439A-B52E-D2D7C829D7C1
PageNumber	integer	返回資料的頁碼。	1
PageSize	integer	整頁大小。	20
TotalCount	integer	總條數。	2
Domains	object
PageData	array<object>	網域名稱資訊。
	array<object>	網域名稱資訊。
SslProtocol	string	HTTPS 開關。取值： on：已開啟。 off：未開啟。	on
Sandbox	string	是否在沙箱。取值： true：是 Null 字元串：否	true
GmtModified	string	加速網域名稱修改時間。	2015-10-28T11:05:52Z
DomainName	string	加速網域名稱。	example.com
DomainId	integer	加速網域名稱 ID。	11223344
GmtCreated	string	加速網域名稱建立時間。	2015-10-28T09:32:51Z
Description	string	網域名稱備案資訊的描述。	filing description
Coverage	string	加速地區。取值： domestic：僅中國內地。 global：全球。 overseas：全球（不包含中國內地）。	domestic
ResourceGroupId	string	資源群組 ID。	abcd1234abcd1234
Cname	string	加速網域名稱對應的 CNAME。	example.com.w.alikunlun.net
DomainStatus	string	加速網域名稱狀態。取值： online：啟用。 offline：停用。 configuring：配置中。 configure_failed：配置失敗。 checking：正在審核。 check_failed：審核失敗。 stopping：停用中。 deleting：刪除中。	configure_failed
CdnType	string	加速業務類型。取值： web：圖片小檔案。 download：大檔案下載。 video：視音頻點播。	download
Sources	object
Source	array<object>	資料類型 Source。
	object	資料類型 Source。
Type	string	來源站點類型。	oss
Weight	string	回源權重。	15
Priority	string	優先順序。	20
Port	integer	來源站點連接埠。	80
Content	string	來源站點地址。	***.oss-cn-hangzhou.aliyuncs.com

樣本

正常返回樣本

JSON格式

{
  "RequestId": "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "SslProtocol": "on",
        "Sandbox": "true",
        "GmtModified": "2015-10-28T11:05:52Z",
        "DomainName": "example.com",
        "DomainId": 11223344,
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "filing description",
        "Coverage": "domestic",
        "ResourceGroupId": "abcd1234abcd1234",
        "Cname": "example.com.w.alikunlun.net",
        "DomainStatus": "configure_failed",
        "CdnType": "download",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "15",
              "Priority": "20",
              "Port": 80,
              "Content": "***.oss-cn-hangzhou.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	網域名稱格式錯誤。
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.
400	InvalidCdnType.Malformed	The specified CdnType is invalid.

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

變更歷史

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