All Products
Search
Document Center

CDN:DescribeDomainsBySource

Last Updated:Aug 06, 2024

Queries accelerated domain names by origin server.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeDomainsBySourcenone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourcesstringYes

The origin servers. Separate multiple origin servers with commas (,). Fuzzy match is not supported.

example.com

Response parameters

ParameterTypeDescriptionExample
object

The data structure of the response.

Sourcesstring

The origin servers.

example.com,aliyundoc.com
RequestIdstring

The ID of the request.

B0F074E5-A1AC-4B32-8EA2-6F450410D1E0
DomainsListarray<object>

The domain names corresponding to each origin server.

object

The domain names corresponding to each origin server.

Sourcestring

The origin server.

example.com
DomainInfosarray<object>

Information about the domain name.

object

The details about the domain name.

Statusstring

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
UpdateTimestring

The update time.

2017-03-31T04:49:00+08:00
CreateTimestring

The creation time.

2016-07-12T11:53:19+08:00
DomainCnamestring

The CNAME record assigned to the domain name.

***.alikunlun.com
CdnTypestring

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
DomainNamestring

The domain name.

example.org
Domainsarray

The domain names that correspond to each origin server.

string

The domain name.

example.org

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParameterThe parameter Sources miss.You must specify the Sources parameter.
400InvalidSources.MalformedSpecified Sources is malformed.The specified origin address is invalid.
400InvalidSources.NotFoundThe sources provided does not found in your domains-

For a list of error codes, visit the Service error codes.