调用DescribeUserDomains查询用户名下所有的域名与状态,支持域名模糊匹配过滤和域名状态过滤。

说明 单用户调用频率:100次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeUserDomains

系统规定参数。取值:DescribeUserDomains

PageSize Integer 5

分页大小,取值1~50,默认值为20,最大值为50

PageNumber Integer 1

取得第几页,取值范围:1~100000

DomainName String example.com

域名模糊匹配过滤。如果不传该参数,默认不匹配。

DomainStatus String configure_failed

域名状态过滤。取值:

  • online:启用。
  • offline:停用。
  • configuring:配置中。
  • configure_failed:配置失败。
  • checking:正在审核。
  • check_failed:审核失败。
  • stopping:停用中。
  • deleting:删除中。

如果不传该参数,默认查询所有状态。

DomainSearchType String fuzzy_match

域名查询类型。取值:

  • fuzzy_match(默认值):模糊匹配。
  • pre_match:前匹配。
  • suf_match:后匹配。
  • full_match:完全匹配。
CdnType String download,web,video

CDN业务类型,多个用英文逗号(,)分隔。取值:

  • web:图片小文件。
  • download:大文件下载。
  • video:视音频点播。

如果不传该参数,默认查询所有业务类型。

CheckDomainShow Boolean false

是否展示审核中、审核失败、配置失败的域名。取值:

  • true:是。
  • false:否。
ResourceGroupId String abcd1234abcd1234

资源组ID,默认查询所有资源组ID。

ChangeStartTime String 2019-10-10T12:14:55Z

更新开始时间,使用UTC时间表示,格式为yyyy-MM-ddTHH:mm:ssZ。

ChangeEndTime String 2019-10-10T12:14:58Z

更新结束时间,使用UTC时间表示,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需大于起始时间。
Tag.N.Key String key

标签键,N的取值范围为1~20

默认查询所有标签键。

Tag.N.Value String value

标签值,N的取值范围为1~20

默认查询所有标签值。

Coverage String domestic

加速区域,默认为全部区域。取值:

  • domestic:仅中国内地。
  • global:全球。
  • overseas:全球(不包含中国内地)。

返回数据

名称 类型 示例值 描述
Domains Array of PageData

域名信息。

PageData
CdnType String download

加速业务类型。取值:

  • web:图片小文件。
  • download:大文件下载。
  • video:视音频点播。
Cname String example.com.w.alikunlun.net

加速域名对应的CNAME。

Coverage String domestic

加速区域。取值:

  • domestic:仅中国内地。
  • global:全球。
  • overseas:全球(不包含中国内地)。
Description String audit failed

审核失败原因。

DomainName String example.com

加速域名。

DomainStatus String configure_failed

加速域名状态。取值:

  • online:启用。
  • offline:停用。
  • configuring:配置中。
  • configure_failed:配置失败。
  • checking:正在审核。
  • check_failed:审核失败。
  • stopping:停用中。
  • deleting:删除中。
GmtCreated String 2015-10-28T09:32:51Z

加速域名创建时间。

GmtModified String 2015-10-28T11:05:52Z

加速域名修改时间。

ResourceGroupId String abcd1234abcd1234

资源组ID。

Sandbox String normal

沙箱。

Sources Array of Source

数据类型Source。

Source
Content String xxx.oss-cn-hangzhou.aliyuncs.com

源站地址。

Port Integer 80

源站端口。

Priority String 20

优先级。

Type String oss

源站类型。

Weight String 15

回源权重。

SslProtocol String on

HTTPS开关。取值:

  • on:已开启。
  • off:未开启。
PageNumber Long 1

返回数据的页码。

PageSize Long 5

整页大小。

RequestId String BDA62CE4-3477-439A-B52E-D2D7C829D7C1

请求ID。

TotalCount Long 16

总条数。

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=DescribeUserDomains
&PageNumber=1
&PageSize=5
&DomainSearchType=fuzzy_match
&Coverage=domestic
&<公共请求参数>

正常返回示例

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>
              <Coverage>domestic</Coverage>
              <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>
              <Coverage>domestic</Coverage>
              <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",
				"Coverage":"domestic",
				"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",
				"Coverage":"domestic",
				"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"
			}
		]
    }
}

错误码

访问错误中心查看更多错误码。