調(diào)用DescribeUserDomains查詢用戶名下所有的域名與狀態(tài)，支持域名模糊匹配過濾和域名狀態(tài)過濾。
接口說明
- 單用戶調(diào)用頻率：100 次/秒。
- 支持批量查詢域名，多個域名用半角逗號（,）分隔，一次最多支持 50 個域名查詢。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cdn:DescribeUserDomains | get | *Domain acs:cdn:*:{#accountId}:domain/* |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageSize | integer | 否 | 分頁大小，取值1~500，默認(rèn)值為 20，最大值為 500。 | 5 |
| PageNumber | integer | 否 | 取得第幾頁，取值范圍：1~100000。 | 1 |
| DomainName | string | 否 | 加速域名。如果不傳該參數(shù)，默認(rèn)不做域名匹配搜索，返回所有符合條件的域名。 | example.com |
| DomainStatus | string | 否 | 域名狀態(tài)過濾。取值：
如果不傳該參數(shù)，默認(rèn)查詢所有狀態(tài)。 | configure_failed |
| DomainSearchType | string | 否 | 域名查詢類型。取值：
說明
傳遞了域名參數(shù)的情況下，不傳 DomainSearchType 參數(shù)，則默認(rèn)采用完全匹配模式。
| fuzzy_match |
| CdnType | string | 否 | CDN 業(yè)務(wù)類型，多個用半角逗號（,）分隔。取值：
如果不傳該參數(shù)，默認(rèn)查詢所有業(yè)務(wù)類型。 | download,web,video |
| CheckDomainShow | boolean | 否 | 是否展示審核中、審核失敗、配置失敗的域名。取值：
| false |
| ResourceGroupId | string | 否 | 資源組 ID，默認(rèn)查詢所有資源組 ID。 | abcd1234abcd1234 |
| ChangeStartTime | string | 否 | 更新開始時間，使用 UTC+0 時間表示，格式為 yyyy-MM-ddTHH:mm:ssZ。 | 2019-10-10T12:14:55Z |
| ChangeEndTime | string | 否 | 更新結(jié)束時間，使用 UTC+0 時間表示，格式為 yyyy-MM-ddTHH:mm:ssZ。 說明
結(jié)束時間需晚于起始時間。
| 2019-10-10T12:14:58Z |
| Coverage | string | 否 | 加速區(qū)域，默認(rèn)為全部區(qū)域。取值：
| domestic |
| Source | string | 否 | 源站信息。 | *** |
| Tag | array<object> | 否 | 標(biāo)簽列表。列表元素最大數(shù)量：20。 | |
| object | 否 | 標(biāo)簽解釋。 | ||
| Key | string | 否 | 標(biāo)簽鍵。 默認(rèn)查詢所有標(biāo)簽鍵。 | key |
| Value | string | 否 | 標(biāo)簽值。 默認(rèn)查詢所有標(biāo)簽值。 | value |
返回參數(shù)
示例
正常返回示例
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. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-05-11 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-08-19 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-06-27 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |