CDN:DescribeUserDomains - CDN

Queries all accelerated domain names in your Alibaba Cloud account and the status of the accelerated domain names. You can filter domain names by name or status. Fuzzy match is supported.

Operation description

Each account can call this operation up to 100 times per second.
You can specify up to 50 domain names in each request. Separate multiple domain names with commas (,).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeUserDomains

get

*Domain

acs:cdn:*:{#accountId}:domain/*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 500. Default value: 20. Maximum value: 500.	5
PageNumber	integer	No	The page number. Valid values: 1 to 100000.	1
DomainName	string	No	The accelerated domain. If you do not set this parameter, all domain names that match the conditions are returned.	example.com
DomainStatus	string	No	The status of the domain name. Valid values: online offline configuring configure_failed checking check_failed stopping deleting If you do not set this parameter, domain names in all states are queried.	configure_failed
DomainSearchType	string	No	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.	fuzzy_match
CdnType	string	No	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.	download,web,video
CheckDomainShow	boolean	No	Specifies whether to display domain names that are under review, failed the review, or failed to be configured. Valid values: true false	false
ResourceGroupId	string	No	The ID of the resource group. By default, all IDs are queried.	abcd1234abcd1234
ChangeStartTime	string	No	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.	2019-10-10T12:14:55Z
ChangeEndTime	string	No	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.	2019-10-10T12:14:58Z
Coverage	string	No	The acceleration region. By default, all acceleration regions are queried. Valid values: domestic: Chinese mainland global: global overseas: outside the Chinese mainland	domestic
Source	string	No	The information about the origin server.	example.source.com
Tag	array<object>	No	The list of tags. Maximum number of elements in the list: 20
	object	No	The details about the tags.
Key	string	No	The key of a tag. By default, all tag keys are queried.	key
Value	string	No	The value of the tag. By default, all tag values are queried.	value

Response elements

Element	Type	Description	Example
	object	The description of returned data.
RequestId	string	The ID of the request.	BDA62CE4-3477-439A-B52E-D2D7C829D7C1
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	2
Domains	object
PageData	array<object>	The list of the accelerated domain names returned.
	array<object>	The information about the accelerated domain name.
SslProtocol	string	Indicates whether HTTPS is enabled. Valid values: on off	on
Sandbox	string	Indicates whether the accelerated domain name is in a sandbox.	true
GmtModified	string	The time when the accelerated domain name was modified.	2015-10-28T11:05:52Z
DomainName	string	The accelerated domain.	example.com
DomainId	integer	The ID of the accelerated domain name.	11223344
GmtCreated	string	The time when the accelerated domain name was added.	2015-10-28T09:32:51Z
Description	string	The information about Internet Content Provider (ICP) filing.	filing description
Coverage	string	The acceleration region. Valid values: domestic: Chinese mainland global: global overseas: outside the Chinese mainland	domestic
ResourceGroupId	string	The ID of the resource group.	abcd1234abcd1234
Cname	string	The CNAME assigned to the accelerated domain name.	example.com.w.alikunlun.net
DomainStatus	string	The status of the accelerated domain name. Valid values: online offline configuring configure_failed checking check_failed stopping deleting	configure_failed
CdnType	string	The type of the workload accelerated by Alibaba Cloud CDN. Valid values: web: images and small files download: large files video: on-demand video and audio streaming	download
Sources	object
Source	array<object>	The information about the origin server.
	object	The details about the origin server.
Type	string	The type of the origin server.	oss
Weight	string	The weight of the origin server if multiple origin servers have been specified.	15
Priority	string	The priority.	20
Port	integer	The port of the origin server.	80
Content	string	The address of the origin server.	***.oss-cn-hangzhou.aliyuncs.com

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.
400	InvalidCdnType.Malformed	The specified CdnType is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.