调用DescribeDcdnUserDomains查询用户名下所有的全站加速域名,支持域名模糊匹配过滤和域名状态过滤。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDcdnUserDomains |
系统规定参数。取值:DescribeDcdnUserDomains。 |
PageSize | Integer | 否 | 20 |
分页大小。默认20,取值:1~500。 |
PageNumber | Integer | 否 | 1 |
页数。取值范围:1~100000。 |
DomainName | String | 否 | example.com |
加速域名。如果不传该参数,默认不做域名匹配搜索,返回所有符合条件的域名。 |
DomainStatus | String | 否 | online |
域名状态过滤。
|
DomainSearchType | String | 否 | fuzzy_match |
域名查询类型。
说明 传递了域名参数的情况下,不传DomainSearchType参数,则默认采用完全匹配模式。
|
CheckDomainShow | Boolean | 否 | false |
是否展示审核中、审核失败、配置失败的域名。取值:
|
ResourceGroupId | String | 否 | rg-acfmv6jutt** |
资源组ID。 |
ChangeStartTime | String | 否 | 2018-05-10T12:00:00Z |
更新开始时间,日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
ChangeEndTime | String | 否 | 2018-05-10T14:00:00Z |
更新结束时间,日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 结束时间需大于起始时间。
|
Coverage | String | 否 | domestic |
加速区域:默认为全部。
|
Tag.N.Key | String | 否 | 1 |
标签键,N的取值范围1~20。通过TagDcdnResources接口可以给域名设置Tag。 |
Tag.N.Value | String | 否 | 1 |
标签值,N的取值范围1~20。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | AA75AADB-5E25-4970-B480-EAA1F5658483 |
请求ID。 |
PageNumber | Long | 1 |
返回数据的页码。 |
PageSize | Long | 12 |
整页大小。 |
TotalCount | Long | 12 |
总条数。 |
Domains | Array of PageData |
由PageData组成的数组格式,返回加速域名的状态信息。 |
|
PageData | |||
GmtCreated | String | 2015-10-28T11:05:50Z |
加速域名创建时间。 |
Description | String | audit failed |
审核失败原因。 |
SSLProtocol | String | on |
HTTPS开关。
|
ResourceGroupId | String | rg-acfmv6jutt** |
资源组ID。 |
Sandbox | String | normal |
沙箱。 |
DomainStatus | String | online |
加速域名状态。
|
Cname | String | test.aliyun.com.w.alikunlun.com |
加速域名对应的CNAME域名。 |
GmtModified | String | 2015-10-28T09:31:59Z |
加速域名修改时间。 |
DomainName | String | www.example.com |
域名信息。 |
DomainId | Long | 11223344 |
加速域名ID。 |
Sources | Array of Source |
源站信息。 |
|
Source | |||
Type | String | oss |
源站类型。 |
Weight | String | 20 |
权重。 |
Priority | String | 20 |
优先级。 |
Port | Integer | 80 |
源站端口。 |
Content | String | example.com |
源站地址。 |
示例
请求示例
https://dcdn.aliyuncs.com/?Action=DescribeDcdnUserDomains
&PageSize=20
&PageNumber=1
&DomainName=example.com
&DomainStatus=online
&DomainSearchType=fuzzy_match
&CheckDomainShow=false
&ResourceGroupId=rg-acfmv6jutt**
&FuncId=13
&FuncFilter=config
&ChangeStartTime=2018-05-10T12:00:00Z
&ChangeEndTime=2018-05-10T14:00:00Z
&Coverage=domestic
&Tag=[{"Key":"1","Value":"1"}]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDcdnUserDomainsResponse>
<RequestId>AA75AADB-5E25-4970-B480-EAA1F5658483</RequestId>
<PageNumber>1</PageNumber>
<PageSize>12</PageSize>
<TotalCount>12</TotalCount>
<Domains>
<GmtCreated>2015-10-28T11:05:50Z</GmtCreated>
<Description>audit failed</Description>
<SSLProtocol>on</SSLProtocol>
<ResourceGroupId>rg-acfmv6jutt**</ResourceGroupId>
<Sandbox>normal</Sandbox>
<DomainStatus>online</DomainStatus>
<Cname>test.aliyun.com.w.alikunlun.com</Cname>
<GmtModified>2015-10-28T09:31:59Z</GmtModified>
<DomainName>www.example.com</DomainName>
<DomainId>11223344</DomainId>
<Sources>
<Type>oss</Type>
<Weight>20</Weight>
<Priority>20</Priority>
<Port>80</Port>
<Content>example.com</Content>
</Sources>
</Domains>
</DescribeDcdnUserDomainsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "AA75AADB-5E25-4970-B480-EAA1F5658483",
"PageNumber" : 1,
"PageSize" : 12,
"TotalCount" : 12,
"Domains" : [ {
"GmtCreated" : "2015-10-28T11:05:50Z",
"Description" : "audit failed",
"SSLProtocol" : "on",
"ResourceGroupId" : "rg-acfmv6jutt**",
"Sandbox" : "normal",
"DomainStatus" : "online",
"Cname" : "test.aliyun.com.w.alikunlun.com",
"GmtModified" : "2015-10-28T09:31:59Z",
"DomainName" : "www.example.com",
"DomainId" : 11223344,
"Sources" : [ {
"Type" : "oss",
"Weight" : "20",
"Priority" : "20",
"Port" : 80,
"Content" : "example.com"
} ]
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPageNumber.ValueNotSupported | The specified value of PageNumber is not supported. | 页码参数错误,请重新填写。 |
400 | InvalidPageSize.ValueNotSupported | The specified value of PageSize is invalid. | PageSize参数错误,请重新填写。 |
400 | InvalidDomainStatus.ValueNotSupported | The specified value of DomainStatus is invalid. | DomainStatus值错误,请重新填写。 |
400 | InvalidDomainName.Malformed | The specified DomainName is invalid. | 域名格式错误。 |
400 | InvalidDomainSearchType.ValueNotSupported | The specified value of DomainSearchType is invalid. | DomainSearchType值错误,请重新填写。 |
400 | InvalidChangeStartTime.Malformed | The specified ChangeStartTime is invalid. | 更新开始时间非法。 |
400 | InvalidChangeEndTime.Malformed | The specified ChangeEndTime is invalid. | 更新结束时间非法。 |
访问错误中心查看更多错误码。