You can call this operation to query all the accelerated domains under your account. You can filter domains by name or status. Fuzzy match is supported.

An accelerated domain supports the following statuses:

  • Online.
  • Offline
  • Configuring
  • Configuration failed
  • Under review
  • Review failed

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDcdnUserDomains

The operation that you want to perform. Set the value to DescribeDcdnUserDomains.

ChangeEndTime String No 2018-05-10T14:00:00Z

The end time of the update. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

The time must be in UTC.

ChangeStartTime String No 2018-05-10T12:00:00Z

The start time of the update. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

The time must be in UTC.

CheckDomainShow Boolean No false

Specifies whether to display the domains in the checking, check_failed, or configure_failed status. Valid values: true or false.

DomainName String No example.com

The name of the accelerated domain, which is used as a condition to filter domain names. Fuzzy match is supported.

DomainSearchType String No fuzzy_match

The search method. Default value: fuzzy_match. Valid values:

  • fuzzy_match: fuzzy match.
  • pre_match: prefix match.
  • suf_match: suffix match.
  • full_match: exact match.
DomainStatus String No Running

The status of the accelerated domain, which is used as a condition to filter domain names.

FuncFilter String No config

The filter feature. Valid values: config: a feature with a funcid. unconfig: a feature without a funcid.

FuncId String No Illicit content moderation.

The ID of the feature.

PageNumber Integer No 1

The number of the page to return. Valid values: 1 to 100000.

PageSize Integer No 20

The number of entries to return on each page. Default value: 20. Maximum value: 50. Valid values: 1 to 50.

ResourceGroupId String No 123

The ID of the resource group.

Response parameters

Parameter Type Example Description
Domains

The detailed information about the accelerated domain status, which is indicated by the PageData parameter.

PageData

The detailed information about each accelerated domain status.

Cname String test.aliyun.com.w.alikunlun.com

The canonical name (CNAME) allocated to the accelerated domain.

Description String audit failed

The reason why the accelerated domain failed review.

DomainName String www.example.com

The information about the accelerated domain.

DomainStatus String online

The status of the accelerated domain. Valid values:

  • online: The domain is enabled.
  • offline: The domain is disabled.
  • configuring: The domain is being configured.
  • configure_failed: The domain configuration failed.
  • checking: The domain is under review.
  • check_failed: The domain failed the review.
GmtCreated String 2015-10-28T11:05:50Z

The time when the accelerated domain was added.

GmtModified String 2015-10-28T09:31:59Z

The time when the accelerated domain was last modified.

ResourceGroupId String abcd1234abcd1234

The ID of the resource group.

SSLProtocol String on

Indicates whether the HTTPS protocol is enabled. Valid values:

  • on: enabled.
  • off: disabled.
Sandbox String normal

Indicates whether the accelerated domain is in a sandbox.

Sources

The origin information.

Source

The information about the origin server.

Content String example.com

The address of the origin.

Port Integer 80

The port of the origin.

Priority String 20

The priority of the origin if multiple origins are specified.

Type String oss

The type of the origin.

Weight String 20

The weight of the origin if multiple origins are specified

PageNumber Long 1

The page number of the returned page.

PageSize Long 12

The number of entries returned on each page.

RequestId String AA75AADB-5E25-4970-B480-EAA1F5658483

The ID of the request.

TotalCount Long 12

The total number of entries returned.

Examples

Sample requests

https://dcdn.aliyuncs.com&Action=DescribeDcdnUserDomains
&PageNumber=1
&PageSize=5
&DomainSearchType=fuzzy_match
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnUserDomainsResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>16</TotalCount>
	  <PageSize>5</PageSize>
	  <RequestId>AA75AADB-5E25-4970-B480-EAA1F5658483</RequestId>
	  <Domains>
		    <PageData>
			      <DomainStatus>configure_failed</DomainStatus>
			      <DomainName>www.example.com</DomainName>
			      <GmtModified>2015-10-28T11:05:52Z</GmtModified>
			      <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>
			      <Description>audit failed</Description>
			      <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
		    </PageData>
		    <PageData>
			      <DomainStatus>configure_failed</DomainStatus>
			      <DomainName>www.example.com</DomainName>
			      <GmtModified>2015-10-28T11:05:50Z</GmtModified>
			      <GmtCreated>2015-10-28T09:31:59Z</GmtCreated>
			      <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
		    </PageData>
		    <PageData>
			      <Cname>onlytest.cdnpe.com.w.alikunlun.net</Cname>
			      <DomainStatus>online</DomainStatus>
			      <DomainName>www.example.com</DomainName>
			      <GmtModified>2015-10-27T06:26:34Z</GmtModified>
			      <GmtCreated>2015-10-23T09:30:00Z</GmtCreated>
			      <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
		    </PageData>
		    <PageData>
			      <Cname>test11.cdnpe.com.w.kunlunAr.com</Cname>
			      <DomainStatus>online</DomainStatus>
			      <DomainName>www.example.com</DomainName>
			      <GmtModified>2015-10-23T09:23:29Z</GmtModified>
			      <GmtCreated>2015-10-23T09:23:20Z</GmtCreated>
			      <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
		    </PageData>
		    <PageData>
			      <Cname>test.aliyun.com.w.alikunlun.com</Cname>
			      <DomainStatus>online</DomainStatus>
			      <DomainName>www.example.com</DomainName>
			      <GmtModified>2015-10-23T09:02:11Z</GmtModified>
			      <GmtCreated>2015-10-23T09:01:57Z</GmtCreated>
			      <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
		    </PageData>
	  </Domains>
</DescribeDcdnUserDomainsResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":16,
	"PageSize":5,
	"RequestId":"AA75AADB-5E25-4970-B480-EAA1F5658483",
	"Domains":{
		"PageData":[
			{
				"Description":"audit failed",
				"ResourceGroupId":"abcd1234abcd1234",
				"DomainStatus":"configure_failed",
				"DomainName":"www.example.com",
				"GmtModified":"2015-10-28T11:05:52Z",
				"GmtCreated":"2015-10-28T09:32:51Z"
			},
			{
				"ResourceGroupId":"abcd1234abcd1234",
				"DomainStatus":"configure_failed",
				"DomainName":"www.example.com",
				"GmtModified":"2015-10-28T11:05:50Z",
				"GmtCreated":"2015-10-28T09:31:59Z"
			},
			{
				"Cname":"onlytest.cdnpe.com.w.alikunlun.net",
				"ResourceGroupId":"abcd1234abcd1234",
				"DomainStatus":"online",
				"DomainName":"www.example.com",
				"GmtModified":"2015-10-27T06:26:34Z",
				"GmtCreated":"2015-10-23T09:30:00Z"
			},
			{
				"Cname":"test11.cdnpe.com.w.kunlunAr.com",
				"ResourceGroupId":"abcd1234abcd1234",
				"DomainStatus":"online",
				"DomainName":"www.example.com",
				"GmtModified":"2015-10-23T09:23:29Z",
				"GmtCreated":"2015-10-23T09:23:20Z"
			},
			{
				"Cname":"test.aliyun.com.w.alikunlun.com",
				"ResourceGroupId":"abcd1234abcd1234",
				"DomainStatus":"online",
				"DomainName":"www.example.com",
				"GmtModified":"2015-10-23T09:02:11Z",
				"GmtCreated":"2015-10-23T09:01:57Z"
			}
		]
	}
}

Error codes

HTTP status code Error code Error message Description
400 InvalidPageNumber.ValueNotSupported The specified value of PageNumber is not supported. The error message returned because the specified PageNumber parameter is invalid.
400 InvalidPageSize.ValueNotSupported The specified value of PageSize is invalid. The error message returned because the specified PageSize parameter is invalid.
400 InvalidDomainStatus.ValueNotSupported The specified value of DomainStatus is invalid. The error message returned because the specified DomainStatus parameter is invalid.
400 InvalidDomainName.Malformed The specified DomainName is invalid. The error message returned because the specified DomainName parameter is invalid.
400 InvalidDomainSearchType.ValueNotSupported The specified value of DomainSearchType is invalid. The error message returned because the specified DomainSearchType parameter is invalid.
400 InvalidChangeStartTime.Malformed The specified ChangeStartTime is invalid. The error message returned because the specified ChangeStartTime parameter is invalid.
400 InvalidChangeEndTime.Malformed The specified ChangeEndTime is invalid. The error message returned because the specified ChangeEndTime parameter is invalid.

For a list of error codes, visit the API Error Center.