All Products
Search
Document Center

CDN:DescribeCdnDomainDetail

Last Updated:Aug 06, 2024

Queries the basic information about an accelerated domain name.

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:DescribeCdnDomainDetailget
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

18CF38AA-1275-451D-A12B-4EC0BF1C5E30
GetDomainDetailModelobject

The details about the accelerated domain name.

GmtCreatedstring

The time when the domain name was created.

2015-06-25T03:30:50Z
Descriptionstring

The description of the domain name.

Streaming domain
HttpsCnamestring

The CNAME for which HTTPS is enabled.

example.com.w.kunlunle.com
ResourceGroupIdstring

The ID of the resource group.

abcd1234abcd1234
ServerCertificateStatusstring

Indicates whether the SSL certificate is enabled. Valid values:

  • on
  • off
on
Scopestring

The acceleration region.

domestic
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online
  • offline
  • configuring
  • configure_failed
  • checking
  • check_failed
  • stopping
  • deleting
online
Cnamestring

The CNAME that is assigned to the accelerated domain name. You must add the CNAME record in the system of your DNS service provider to map the accelerated domain name to the CNAME.

example.com.w.kunlunle.com
GmtModifiedstring

The time when the domain name was last modified.

2017-06-25T03:30:50Z
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 accelerated domain name.

example.com
SourceModelsarray<object>

The information about the origin server.

object
Typestring

The type of the origin server. Valid values:

  • ipaddr: an origin IP address
  • domain: an origin domain name
  • oss: the domain name of an Object Storage Service (OSS) bucket
  • fc_domain: a Function Compute domain name
domain
Weightstring

The weight of the origin server if multiple origin servers have been specified.

10
Enabledstring

The status.

online
Prioritystring

The priority.

20
Portinteger

The port over which requests are redirected to the origin server. Ports 443 and 80 are supported.

80
Contentstring

The address of the origin server.

example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "18CF38AA-1275-451D-A12B-4EC0BF1C5E30",
  "GetDomainDetailModel": {
    "GmtCreated": "2015-06-25T03:30:50Z",
    "Description": "Streaming domain\n",
    "HttpsCname": "example.com.w.kunlunle.com",
    "ResourceGroupId": "abcd1234abcd1234",
    "ServerCertificateStatus": "on",
    "Scope": "domestic",
    "DomainStatus": "online",
    "Cname": "example.com.w.kunlunle.com",
    "GmtModified": "2017-06-25T03:30:50Z",
    "CdnType": "web",
    "DomainName": "example.com",
    "SourceModels": {
      "SourceModel": [
        {
          "Type": "domain",
          "Weight": "10",
          "Enabled": "online",
          "Priority": "20",
          "Port": 80,
          "Content": "example.com"
        }
      ]
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-08-19The response structure of the API has changedView Change Details
2023-06-27The response structure of the API has changedView Change Details