DescribeUserDomains

Last Updated: May 27, 2016

Description

Queries all domain names and statuses under a user name. Domain name statuses include:

  • running (indicates the domain name service is normal and can be used)
  • stopped
  • configuring
  • configure_failed

Request Parameters

Parameter Type Required Description
Action String Yes Operator interface name, required parameter, values:DescribeUserDomains
PageSize Integer No Page size, default value of 20, maximum of 50, values:Any integer from 1 to 50
PageNumber Integer No Retrieves a certain page number, range:1~100000

Return Parameters

Name Type Description
Domains Struct List composed of domains
PageSize Integer Full page size
PageNumber Integer Returned data page
TotalCount Integer Total number of items

Specific Error Codes

ErrorCode Message HTTP Status
OperationDenied Your account does not open CDN service yet 403

Examples

Request example

https://cdn.aliyuncs.com?&Action=DescribeUserDomains&PageNumber=1&PageSize=5&<Common Request Parameter>

Return example

JSON format:

{
    "Domains" : {
        "CDNDomain" : [{
                "DomainName" : "***.***.com",
                "DomainStatus" : "online"
            }, {
                "DomainName" : "***.***.com ",
                "DomainStatus" : "online "
            }, {
                "DomainName" : "***.***.com ",
                "DomainStatus" : "online "
            }, {
                "DomainName" : "***.***.com ",
                "DomainStatus" : "online"
            }, {
                "DomainName" : "***.***.com ",
                "DomainStatus" : "configure_failed"
            }
        ]
    },
    "PageNumber" : 1,
    "PageSize" : 5,
    "TotalCount" : 14,
    "RequestId" : "9D73CF5C-FAD6-4DE1-BA0F-6DAABE66BE9F"
}

XML format:

<?xml version="1.0" encoding="utf-8"?>
<DescribeUserDomainsResponse>
  <Domains>
    <CDNDomain>
      <DomainName>***.***.com</DomainName>
      <DomainStatus>online</DomainStatus>
    </CDNDomain>
    <CDNDomain>
      <DomainName>***.***.com</DomainName>
      <DomainStatus>offline </DomainStatus>
    </CDNDomain>
    <CDNDomain>
      <DomainName>***.***.com </DomainName>
      <DomainStatus>online </DomainStatus>
    </CDNDomain>
    <CDNDomain>
      <DomainName>***.***.com </DomainName>
      <DomainStatus>online</DomainStatus>
    </CDNDomain>
    <CDNDomain>
      <DomainName>***.***.com </DomainName>
      <DomainStatus>configure_failed</DomainStatus>
    </CDNDomain>
  </Domains>
  <PageNumber>1</PageNumber>
  <PageSize>5</PageSize>
  <TotalCount>14</TotalCount>
  <RequestId>E107FDE8-84D9-465D-B73B-DF41BADB0049</RequestId>
</DescribeUserDomainsResponse>
Thank you! We've received your feedback.