调用DescribeUserDomains查询用户名下所有的域名与状态。
支持域名模糊匹配过滤和域名状态过滤。域名状态包括:
- 运行中(表示域名服务状态正常,可以使用)。
- 已停止。
- 配置中。
- 配置失败。
- 审核中。
- 审核失败。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeUserDomains |
操作接口名,系统规定参数。取值:DescribeUserDomains。 |
PageSize | Integer | 否 | 20 |
分页大小。 取值范围:1~50之间的任意整数。 默认值:20。 |
PageNumber | Integer | 否 | 1 |
取得第几页。 取值范围:1~100000。 |
DomainName | String | 否 | www.yourdomain.com |
域名模糊匹配过滤。 |
DomainStatus | String | 否 | online |
域名状态过滤。 |
DomainSearchType | String | 否 | fuzzy_match |
域名查询类型。
|
Sources | String | 否 | a.b.com |
根据回源地址查询。 |
CdnType | String | 否 | web |
CDN业务类型,多个用逗号(,)隔开。
|
CheckDomainShow | Boolean | 否 | true |
是否显示审核状态域名。
|
ResourceGroupId | String | 否 | your resourceGroupId |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | AA75AADB-5E25-4970-B480-EAA1F5658483 |
请求ID。 |
PageNumber | Long | 1 |
返回数据的页码。 |
PageSize | Long | 5 |
整页大小。 |
TotalCount | Long | 16 |
总条数。 |
Domains | Array |
域名列表信息。 |
|
PageData | |||
DomainName | String | onlytest.cdnpe.com |
加速域名。 |
Cname | String | onlytest.cdnpe.com.w.alikunlun.net |
加速域名对应的CNAME域名。 |
CdnType | String | video |
加速业务类型。
|
DomainStatus | String | online |
加速域名状态。
|
GmtCreated | String | 2015-10-28T09:31:59Z |
加速域名创建时间。 |
GmtModified | String | 2015-10-28T11:05:50Z |
加速域名修改时间。 |
Description | String | audit failed |
审核失败原因。 |
ResourceGroupId | String | abcd1234abcd1234 |
资源组ID。 |
Sandbox | String | (空) |
沙箱。 |
SourceType | String | oss |
源站类型。 |
Sources | List | { "Source": [ "a.b.com" ] } |
源站信息。 |
SslProtocol | String | on |
开关。 |
示例
请求示例
http(s)://cdn.aliyuncs.com/?Action=DescribeUserDomains
&PageSize=20
&PageNumber=1
&DomainName=www.yourdomain.com
&DomainStatus=online
&DomainSearchType=fuzzy_match
&Sources=a.b.com
&CdnType=web
&CheckDomainShow=true
&ResourceGroupId=your resourceGroupId
&<公共请求参数>
正常返回示例
XML
格式
<DescribeUserDomainsResponse>
<PageNumber>1</PageNumber>
<TotalCount>5</TotalCount>
<PageSize>20</PageSize>
<RequestId>BDA62CE4-3477-439A-B52E-D2D7C829D7C1</RequestId>
<Domains>
<PageData>
<Cname>xxx.alikunlun.com</Cname>
<Description></Description>
<CdnType>web</CdnType>
<ResourceGroupId>xxxklq4a</ResourceGroupId>
<DomainStatus>online</DomainStatus>
<SslProtocol>off</SslProtocol>
<DomainName>xxx.com</DomainName>
<Sources>
<Source>
<Port>80</Port>
<Weight>15</Weight>
<Type>oss</Type>
<Content>xxx.oss-cn-hangzhou.aliyuncs.com</Content>
<Priority>20</Priority>
</Source>
</Sources>
<GmtModified>2019-09-11T15:03Z</GmtModified>
<Sandbox></Sandbox>
<GmtCreated>2019-09-10T06:11:11Z</GmtCreated>
</PageData>
<PageData>
<Cname>xxxalikunlun.com</Cname>
<Description>xxx-19</Description>
<CdnType>download</CdnType>
<ResourceGroupId>xxxrjyolklq4a</ResourceGroupId>
<DomainStatus>online</DomainStatus>
<SslProtocol>off</SslProtocol>
<DomainName>xxxujia.com</DomainName>
<Sources>
<Source>
<Port>80</Port>
<Weight>10</Weight>
<Type>oss</Type>
<Content>xxx.oss-cn-hangzhou.aliyuncs.com</Content>
<Priority>20</Priority>
</Source>
</Sources>
<GmtModified>2019-07-10T13:19Z</GmtModified>
<Sandbox></Sandbox>
<GmtCreated>2019-07-10T03:07:14Z</GmtCreated>
</PageData>
</Domains>
</DescribeUserDomainsResponse>
JSON
格式
{
"PageNumber": 1,
"TotalCount": 5,
"PageSize": 20,
"RequestId": "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
"Domains": {
"PageData": [
{
"Cname": "xxx.alikunlun.com",
"Description": "",
"CdnType": "web",
"ResourceGroupId": "xxxklq4a",
"DomainStatus": "online",
"SslProtocol": "off",
"DomainName": "xxx.com",
"Sources": {
"Source": [
{
"Port": 80,
"Weight": "15",
"Type": "oss",
"Content": "xxx.oss-cn-hangzhou.aliyuncs.com",
"Priority": "20"
}
]
},
"GmtModified": "2019-09-11T15:03Z",
"Sandbox": "",
"GmtCreated": "2019-09-10T06:11:11Z"
},
{
"Cname": "xxxalikunlun.com",
"Description": "xxx-19",
"CdnType": "download",
"ResourceGroupId": "xxxrjyolklq4a",
"DomainStatus": "online",
"SslProtocol": "off",
"DomainName": "xxxujia.com",
"Sources": {
"Source": [
{
"Port": 80,
"Weight": "10",
"Type": "oss",
"Content": "xxx.oss-cn-hangzhou.aliyuncs.com",
"Priority": "20"
}
]
},
"GmtModified": "2019-07-10T13:19Z",
"Sandbox": "",
"GmtCreated": "2019-07-10T03:07:14Z"
}
]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPageNumber.ValueNotSupported | The specified value of parameter PageNumber is not supported. | 指定查询的当前页码参数值不合法。 |
400 | InvalidPageSize.ValueNotSupported | The specified value of parameter PageSize is not supported. | 指定查询的分页大小参数PageSize值不合法。 |
400 | InvalidDomainStatus.ValueNotSupported | The specified value of parameter DomainStatus is not supported. | 不支持参数DomainStatus。 |
400 | InvalidCdnType.ValueNotSupported | The specified value of parameter CdnType is not supported. | 参数CdnType不支持该参数值, 取值:web:图片及小文件分发;download:大文件下载加速;video:视音频点播加速;liveStream:直播流媒体加速。 |
400 | InvalidDomainName.Malformed | The specific value of parameter DomainName is malformed. | 域名不存在或不属于当前用户。请检查您填写的域名书写是否正确,或者域名是否在当前账号中,查看域名是否过期。 |
400 | InvalidDomainSearchType.ValueNotSupported | The specified value of parameter DomainSearchType is not supported. | 不支持参数DomainSearchType。 |
400 | MissingParameter | Missing Parameter. | 缺少参数。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交