Queries the accelerated domain names 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 name is enabled.
  • offline: The domain name is disabled.
  • configuring: The domain name is being configured.
  • configure_failed: The domain name has failed to be configured.
  • checking: The domain name is under review.
  • check_failed: The domain name 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 domain names that are under review, failed the review, or failed to be configured. Valid values: true and false.

ResourceGroupId String No rg-acfmv6jutt**

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.

Note The end time must be later than the start time.

Response parameters

Parameter Type Example Description
Domains Array of PageData

The detailed information about each accelerated domain name. The returned information is displayed in the format that is specified by the PageData parameter.

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

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

Description String audit failed

The reason why the accelerated domain failed the review.

DomainName String www.example.com

The information about the accelerated domain name.

DomainStatus String online

The status of the accelerated domain name. Valid values:

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

The time when the accelerated domain name was added.

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

The time when the accelerated domain name was last modified.

ResourceGroupId String rg-acfmv6jutt**

The ID of the resource group.

SSLProtocol String on

Indicates whether the HTTPS protocol is enabled.

  • on: The HTTPS protocol is enabled.
  • off: The HTTPS protocol is disabled.
Sandbox String normal

Indicates whether the accelerated domain name is in a sandbox environment.

Sources Array of Source

The information about the origin server.

Source
Content String example.com

The address of the origin server.

Port Integer 80

The port of the origin server.

Priority String 20

The priority of the origin server.

Type String oss

The type of origin server.

Weight String 20

The weight of the origin server.

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>rg-acfmv6jutt**</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>rg-acfmv6jute**</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>rg-acfmv6jutr**</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>rg-acfmv6jutf**</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>rg-acfmv6jutu**</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":"rg-acfmv6jutt**"
      },
      {
        "DomainStatus": "configure_failed",
        "DomainName": "www.example.com",
        "GmtModified": "2015-10-28T11:05:50Z",
        "GmtCreated": "2015-10-28T09:31:59Z",
        "ResourceGroupId":"rg-acfmv6jute**"
      },
      {
        "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":"rg-acfmv6jutr**"
      },
      {
        "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":"rg-acfmv6jutf**"
      },
      {
        "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":"rg-acfmv6jutu**"
      }
    ]
  }
}

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 domain name format 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.