You can call the DescribeUserDomains operation to query CDN domains and their status under your account. You can filter domains by name or by status. Fuzzy match is supported.

A CDN domain supports the following statuses:

  • Enabled
  • Disabled
  • Configuring
  • Configuration failed
  • Under review
  • Review failed

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Description
Action String  Yes The operation that you want to perform. Set this parameter to DescribeUserDomains.
PageSize Long No The maximum number of entries to return on each page. Valid values: 1 to 50. Default value: 20.
PageNumber Long No The number of the page to return. Valid values: 1 to 100000.
DomainName String No The domain name, which is used as a condition to match and filter domain names.
DomainSearchType String No The search method. Valid values:
  • fuzzy_match: fuzzy match
  • pre_match: prefix match
  • suf_match: suffix match
  • full_match: exact match

Default value: fuzzy_match

CdnType String No The business type. You can specify multiple business types and separate them with commas (,).
DomainStatus String No The status of the domain, which is used as a condition to filter domain names.
ResourceGroupId String No The ID of the resource group.
FuncFilter String No The configuration status of the specified feature, which is used as a condition to filter domain names. Valid values:
  • config: The feature specified by the FuncId parameter is configured.
  • unconfig: The feature specified by the FuncId parameter is not configured.
FuncId String No The ID of the feature. For example, the ID for the illicit content moderation feature is 98.

Response parameters

Parameter Type Description
RequestId String The ID of the request.
PageNumber Long The number of the page returned.
PageSize Long The maximum number of entries that can be returned on each page.
TotalCount Long The total number of entries returned.
Domains Domains The detailed information about each CDN domain returned.

Parameters in Domains

Parameter Type Description
DomainName String The name of the CDN domain.
Cname String The CNAME.
DomainStatus String The status of the CDN domain.
  • 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.
CdnType String The business type of the CDN domain.
  • web: the acceleration of image and small file distribution.
  • download: the acceleration of large file downloads.
  • video: the acceleration of on-demand video and audio streaming.
  • livestream: the acceleration of live streaming.
  • httpsdelivery: HTTPS secure acceleration.
GmtCreated String The time when the CDN domain was added.
GmtModified String The time when the CDN domain was last modified.
Description String The reason that causes the review failure.
ResourceGroupId String The ID of the resource group.
SslProtocol String The status of the HTTPS protocol.
  • on: enabled
  • off: disabled
Sources Source[] The origin information of the CDN domain.

Parameters in Source

Parameter Type Description
Type String The type of the origin.
Content String The address of the origin.
Port Integer The port of the origin.
Priority String The priority of the origin if multiple origins are specified.
Weight String The weight of the origin if multiple origins are specified.

Examples

Sample request

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

Sample success response

JSON format

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

Error codes

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