Queries the accelerated domains in your account. You can filter domains by name or by state. When you filter domains by name, a fuzzy match is supported.

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.

PageSize Integer No 20

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

PageNumber Integer No 1

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

DomainName String No example.com

The domain name. The value of this parameter is used as a filter condition for a fuzzy match.

DomainStatus String No online

The domain status. The value of this parameter is used as a condition to filter domain names.

  • online: The domain is enabled.
  • offline: The domain is disabled.
  • configuring: The domain is being configured.
  • configure_failed: The domain has failed to be configured.
  • checking: The domain is under review.
  • check_failed: The domain has failed the review.
DomainSearchType String No fuzzy_match

The search method. Valid values:

  • fuzzy_match: fuzzy match. The default value is fuzzy_match.
  • pre_match: prefix match.
  • suf_match: suffix match.
  • full_match: exact match.
CheckDomainShow Boolean No false

Specifies whether to display the domains that are in the checking, check_failed, or configure_failed state. Valid values: true and false.

ResourceGroupId String No 123

The ID of the resource group.

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.

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.

The end time must be later than the start time.

Response parameters

Parameter Type Example Description
Domains Array

The details about the accelerated domain status. The details are organized in an array. The array consists of the subparameter values of the PageData parameter.

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

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

Description String audit failed

The reason why the accelerated domain failed the 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 has failed to be configured.
  • checking: The domain is under review.
  • check_failed: The domain has 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.

  • on: enabled
  • off: disabled
Sandbox String normal

Indicates whether the accelerated domain is in a sandbox environment.

Sources Array

The origin information.

Source
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.

Type String oss

The type of the origin.

Weight String 20

The weight of the origin.

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": [
      {
        "DomainStatus": "configure_failed",
        "DomainName": "www.example.com",
        "GmtModified": "2015-10-28T11:05:52Z",
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "audit failed",
        "ResourceGroupId":"abcd1234abcd1234"
      },
      {
        "DomainStatus": "configure_failed",
        "DomainName": "www.example.com",
        "GmtModified": "2015-10-28T11:05:50Z",
        "GmtCreated": "2015-10-28T09:31:59Z",
        "ResourceGroupId":"abcd1234abcd1234"
      },
      {
        "Cname": "onlytest.cdnpe.com.w.alikunlun.net",
        "DomainStatus": "online",
        "DomainName": "www.example.com",
        "GmtModified": "2015-10-27T06:26:34Z",
        "GmtCreated": "2015-10-23T09:30:00Z",
        "ResourceGroupId":"abcd1234abcd1234"
      },
      {
        "Cname": "test11.cdnpe.com.w.kunlunAr.com",
        "DomainStatus": "online",
        "DomainName": "www.example.com",
        "GmtModified": "2015-10-23T09:23:29Z",
        "GmtCreated": "2015-10-23T09:23:20Z",
        "ResourceGroupId":"abcd1234abcd1234"
      },
      {
        "Cname": "test.aliyun.com.w.alikunlun.com",
        "DomainStatus": "online",
        "DomainName": "www.example.com",
        "GmtModified": "2015-10-23T09:02:11Z",
        "GmtCreated": "2015-10-23T09:01:57Z",
        "ResourceGroupId":"abcd1234abcd1234"
      }
    ]
  }
}

Error codes

HttpCode Error code Error message Description
400 InvalidPageNumber.ValueNotSupported The specified value of PageNumber is not supported. The error message returned because the specified value of the PageNumber parameter is invalid. Specify a valid value.
400 InvalidPageSize.ValueNotSupported The specified value of PageSize is invalid. The error message returned because the specified value of the PageSize parameter is invalid. Specify a valid value.
400 InvalidDomainStatus.ValueNotSupported The specified value of DomainStatus is invalid. The error message returned because the specified value of the DomainStatus parameter is invalid. Specify a valid value.
400 InvalidDomainName.Malformed The specified DomainName is invalid. The error message returned because the format of the specified domain name is invalid.
400 InvalidDomainSearchType.ValueNotSupported The specified value of DomainSearchType is invalid. The error message returned because the specified value of the DomainSearchType parameter is invalid. Specify a valid value.
400 InvalidChangeStartTime.Malformed The specified ChangeStartTime is invalid. The error message returned because the specified value of the ChangeStartTime parameter is invalid.
400 InvalidChangeEndTime.Malformed The specified ChangeEndTime is invalid. The error message returned because the specified value of the ChangeEndTime parameter is invalid.

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