Use DescribeDomainsBySource to query domain names by origin server - CDN

Queries accelerated domain names by origin server.

Operation description

Note

Each account can call this operation up to 30 times per second.

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:DescribeDomainsBySource

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Sources	string	Yes	The origin servers. Separate multiple origin servers with commas (,). Fuzzy match is not supported.	example.com

Response elements

Element	Type	Description	Example
	object	The data structure of the response.
Sources	string	The origin servers.	example.com,aliyundoc.com
RequestId	string	The ID of the request.	B0F074E5-A1AC-4B32-8EA2-6F450410D1E0
DomainsList	object
DomainsData	array<object>	The domain names corresponding to each origin server.
	array<object>	The domain names corresponding to each origin server.
Source	string	The origin server.	example.com
DomainInfos	object
domainInfo	array<object>	Information about the domain name.
	object	The details about the domain name.
Status	string	The status of the domain name. Valid values: applying: The domain name is under review. configuring: The domain name is being configured. online: The domain name is working as expected. stopping: The domain name is being stopped. offline: The domain name is disabled. disabling: The domain name is being removed.	online
UpdateTime	string	The update time.	2017-03-31T04:49:00+08:00
CreateTime	string	The creation time.	2016-07-12T11:53:19+08:00
DomainCname	string	The CNAME record assigned to the domain name.	***.alikunlun.com
CdnType	string	The workload type of the accelerated domain name. Valid values: web: images and small files download: large files video: on-demand video and audio streaming	web
DomainName	string	The domain name.	example.org
Domains	object
domainNames	array	The domain names that correspond to each origin server.
	string	The domain name.	example.org

Examples

Success response

JSON format

{
  "Sources": "example.com,aliyundoc.com",
  "RequestId": "B0F074E5-A1AC-4B32-8EA2-6F450410D1E0",
  "DomainsList": {
    "DomainsData": [
      {
        "Source": "example.com",
        "DomainInfos": {
          "domainInfo": [
            {
              "Status": "online",
              "UpdateTime": "2017-03-31T04:49:00+08:00",
              "CreateTime": "2016-07-12T11:53:19+08:00",
              "DomainCname": "***.alikunlun.com",
              "CdnType": "web",
              "DomainName": "example.org"
            }
          ]
        },
        "Domains": {
          "domainNames": [
            "example.org"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The parameter Sources miss.
400	InvalidSources.Malformed	Specified Sources is malformed.	The specified origin address is invalid.
400	InvalidSources.NotFound	The sources provided does not found in your domains

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.