Queries basic configurations of specified accelerated domain names.

Note
  • The maximum number of times that each user can call this operation per second is 100.
  • You can specify multiple domain names and separate them with commas (,). You can specify at most 50 domain names in each call.

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 DescribeUserDomains

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

PageSize Integer No 5

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

PageNumber Integer No 1

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

DomainName String No example.com

The accelerated domain names. If you do not set this parameter, configurations of all domain names that match the conditions are returned.

DomainStatus String No configure_failed

The status of the domain name. You can filter domain names by status. Valid values:

  • online: enabled
  • offline: disabled
  • configuring: being configured
  • configure_failed: failed to be configured
  • checking: under review
  • check_failed: failed the review
  • stopping: being disabled
  • deleting: deleting

If you do not set this parameter, all states are queried.

DomainSearchType String No fuzzy_match

The search mode. Valid values:

  • fuzzy_match: fuzzy match
  • pre_match: prefix match
  • suf_match: suffix match
  • full_match (default): exact match
Note If you specify the domain names to query but do not set the DomainSearchType parameter, the exact match mode is used.
CdnType String No download,web,video

The type of workload accelerated by Alibaba Cloud CDN. Separate types with commas (,). Valid values:

  • web: images and small files
  • download: large files
  • video: on-demand video and audio streaming

If you do not set this parameter, all service types are queried.

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: yes
  • false: no
ResourceGroupId String No abcd1234abcd1234

The ID of the resource group. By default, all IDs are queried.

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

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

The end of the time range to query. Specify the time 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.
Coverage String No domestic

The accelerated region. By default, all accelerated regions are queried. Valid values:

  • domestic: Chinese mainland
  • global: global
  • overseas: global (excluding the Chinese mainland)
Source String No ***

The information about the origin server.

Tag.N.Key String No key

The key of the tag. Valid values of N: 1 to 20.

By default, all tag keys are queried.

Tag.N.Value String No value

The value of the tag. Valid values of N: 1 to 20.

By default, all tag values are queried.

Response parameters

Parameter Type Example Description
RequestId String BDA62CE4-3477-439A-B52E-D2D7C829D7C1

The ID of the request.

PageNumber Long 1

The page number of the returned page.

PageSize Long 20

The number of entries returned per page.

TotalCount Long 2

The total number of entries returned.

Domains Array of PageData

The information about the accelerated domain name.

PageData
GmtCreated String 2015-10-28T09:32:51Z

The time when the accelerated domain name was added to Alibaba Cloud CDN.

SslProtocol String on

Indicates whether HTTPS is enabled. Valid values:

  • on: enabled
  • off: disabled
Description String filing description

The information about the Internet Content Provider (ICP) number.

Coverage String domestic

The acceleration region. Valid values:

  • domestic: Chinese mainland
  • global: global
  • overseas: global (excluding the Chinese mainland)
ResourceGroupId String abcd1234abcd1234

The ID of the resource group.

Sandbox String normal

Indicates whether the accelerated domain name is in a sandbox.

DomainStatus String configure_failed

The status of the accelerated domain name. Valid values:

  • online: enabled
  • offline: disabled
  • configuring: being configured
  • configure_failed: failed to be configured
  • checking: under review
  • check_failed: failed the review
  • stopping: being disabled
  • deleting: deleting
Cname String example.com.w.alikunlun.net

The CNAME assigned to the accelerated domain name.

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

The last time when the accelerated domain was modified.

CdnType String download

The type of workload accelerated by Alibaba Cloud CDN. Valid values:

  • web: images and small files
  • download: large files
  • video: on-demand video and audio streaming
DomainName String example.com

The accelerated domain name.

Sources Array of Source

The information about the origin server.

Source
Type String oss

The type of the origin server.

Weight String 15

The weight of the origin server if multiple origin servers are specified.

Priority String 20

The priority of the origin server.

Port Integer 80

The port of the origin server.

Content String ***.oss-cn-hangzhou.aliyuncs.com

The address of the origin server.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeUserDomains
&PageNumber=1
&PageSize=5
&DomainSearchType=fuzzy_match
&Coverage=domestic
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<PageSize>20</PageSize>
<RequestId>BDA62CE4-3477-439A-B52E-D2D7C829D7C1</RequestId>
<Domains>
    <PageData>
        <Cname>example.com.w.alikunlun.net</Cname>
        <Description>filing description</Description>
        <CdnType>download</CdnType>
        <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
        <DomainStatus>configure_failed</DomainStatus>
        <SslProtocol>on</SslProtocol>
        <DomainName>example.com</DomainName>
        <Coverage>domestic</Coverage>
        <Sources>
            <Source>
                <Port>80</Port>
                <Weight>15</Weight>
                <Type>oss</Type>
                <Content>***.oss-cn-hangzhou.aliyuncs.com</Content>
                <Priority>20</Priority>
            </Source>
        </Sources>
        <GmtModified>2015-10-28T11:05:52Z</GmtModified>
        <Sandbox>normal</Sandbox>
        <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>
    </PageData>
    <PageData>
        <Cname>example.com.w.alikunlun.net</Cname>
        <Description>filing description</Description>
        <CdnType>download</CdnType>
        <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>
        <DomainStatus>configure_failed</DomainStatus>
        <SslProtocol>on</SslProtocol>
        <DomainName>example.com</DomainName>
        <Coverage>domestic</Coverage>
        <Sources>
            <Source>
                <Port>80</Port>
                <Weight>15</Weight>
                <Type>oss</Type>
                <Content>***.oss-cn-hangzhou.aliyuncs.com</Content>
                <Priority>20</Priority>
            </Source>
        </Sources>
        <GmtModified>2015-10-28T11:05:52Z</GmtModified>
        <Sandbox>normal</Sandbox>
        <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>
    </PageData>
</Domains>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "TotalCount" : 2,
  "PageSize" : 20,
  "RequestId" : "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
  "Domains" : {
    "PageData" : [ {
      "Cname" : "example.com.w.alikunlun.net",
      "Description" : "filing description",
      "CdnType" : "download",
      "ResourceGroupId" : "abcd1234abcd1234",
      "DomainStatus" : "configure_failed",
      "SslProtocol" : "on",
      "DomainName" : "example.com",
      "Coverage" : "domestic",
      "Sources" : {
        "Source" : [ {
          "Port" : 80,
          "Weight" : "15",
          "Type" : "oss",
          "Content" : "***.oss-cn-hangzhou.aliyuncs.com",
          "Priority" : "20"
        } ]
      },
      "GmtModified" : "2015-10-28T11:05:52Z",
      "Sandbox" : "normal",
      "GmtCreated" : "2015-10-28T09:32:51Z"
    }, {
      "Cname" : "example.com.w.alikunlun.net",
      "Description" : "filing description",
      "CdnType" : "download",
      "ResourceGroupId" : "abcd1234abcd1234",
      "DomainStatus" : "configure_failed",
      "SslProtocol" : "on",
      "DomainName" : "example.com",
      "Coverage" : "domestic",
      "Sources" : {
        "Source" : [ {
          "Port" : 80,
          "Weight" : "15",
          "Type" : "oss",
          "Content" : "***.oss-cn-hangzhou.aliyuncs.com",
          "Priority" : "20"
        } ]
      },
      "GmtModified" : "2015-10-28T11:05:52Z",
      "Sandbox" : "normal",
      "GmtCreated" : "2015-10-28T09:32:51Z"
    } ]
  }
}

Error codes

HttpCode Error codes Error message Description
400 InvalidDomainName.Malformed The specified DomainName is invalid. The error message returned because the DomainName parameter is set to an invalid value.

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