DescribeDomainsBySource - API Reference| Alibaba Cloud Documentation Center

Note The maximum number of times that each user can call this operation per second is 30.

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 parameter


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDomainsBySource	The operation that you want to perform. Set the value to DescribeDomainsBySource.
Sources	String	Yes	example.com	The origin servers. Separate origin servers with commas (,). Fuzzy match is not supported.

Response parameters


Parameter	Type	Example	Description
Sources	String	example.com,aliyundoc.com	The origin servers.
RequestId	String	B0F074E5-A1AC-4B32-8EA2-6F450410D1E0	The ID of the request.
DomainsList	Array of DomainsData		The domain names corresponding to each origin server. The data is indicated by the DomainsData parameter. Data type: array.
DomainsData
Source	String	example.com	An origin server.
DomainInfos	Array of domainInfo		The detailed information about the domain name. The data is indicated by the domainInfo parameter. Data type: array.
domainInfo
Status	String	online	The status of the accelerated domain name. Valid values: applying: The domain name is under review. configure_failed: The domain name failed the 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 disabled.
UpdateTime	String	2017-03-31T04:49:00+08:00	The time when the configuration was updated.
CreateTime	String	2016-07-12T11:53:19+08:00	The time when the domain name was added to Alibaba Cloud CDN.
DomainCname	String	example.com	The CNAME assigned to the domain name.
CdnType	String	web	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.
DomainName	String	example.org	The domain name.
Domains	Array of String	example.org	The domain names that correspond to each origin server. The domain name is indicated by the domainNames parameter. Data type: array.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainsBySource
&Sources=example.com  
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDomainsBySourceResponse>
    <Sources>example.com,aliyundoc.com</Sources>
    <RequestId>B0F074E5-A1AC-4B32-8EA2-6F450410D1E0</RequestId>
    <DomainsList>
        <Source>example.com</Source>
        <DomainInfos>
            <Status>online</Status>
            <UpdateTime>2017-03-31T04:49:00+08:00</UpdateTime>
            <CreateTime>2016-07-12T11:53:19+08:00</CreateTime>
            <DomainCname>example.com</DomainCname>
            <CdnType>web</CdnType>
            <DomainName>example.org</DomainName>
        </DomainInfos>
        <Domains>example.org</Domains>
    </DomainsList>
</DescribeDomainsBySourceResponse>

JSON format

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

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

Error codes


HttpCode	Error code	Error message	Description
400	MissingParameter	The parameter Sources miss.	The error message returned because the Sources parameter is not set.
400	InvalidSources.Malformed	Specified Sources is malformed.	The error message returned because the origin address is specified in an invalid format.

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