All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainDetail

Last Updated:Mar 01, 2024

Queries the basic configuration 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
dcdn:DescribeDcdnDomainDetailRead
  • domain
    acs:dcdn:*:{#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.

09ABE829-6CD3-4FE0-AFEE-556113E29727
DomainDetailobject

The information about the accelerated domain name.

GmtCreatedstring

The time when the domain name was added.

2017-11-27T06:51:26Z
SSLPubstring

The public key of the certificate if HTTPS is enabled.

xxx
Descriptionstring

The information about the Internet content provider (ICP) filing of the domain name.

Beijing ICP Filing No. 1703xxxx
SSLProtocolstring

Indicates whether the Security Socket Layer (SSL) certificate is enabled. Valid values:

  • on: enabled
  • off: disabled
on
ResourceGroupIdstring

The ID of the resource group.

rg-acfmyuji4b6r4**
Scopestring

The acceleration region. Default value: domestic. Valid values:

  • domestic: Chinese mainland
  • overseas: global (excluding the Chinese mainland)
  • global: global
overseas
Cnamestring

The CNAME that is assigned to the accelerated domain name. You must add the CNAME record to the system of your Domain Name System (DNS) provider to map the accelerated domain name to the CNAME.

example.aliyundoc.com
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online
  • offline
  • configuring
  • configure_failed
  • checking
  • check_failed
online
GmtModifiedstring

The time when the domain name was last modified.

2017-11-27T06:51:25Z
DomainNamestring

The accelerated domain name.

example.com
Sourcesobject []

The information about the origin server.

Typestring

The type of the origin server. Valid values:

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

The weight of the origin server if multiple origin servers are specified.

20
Enabledstring

The status.

online
Prioritystring

The priority.

50
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.org
Scenestring

Acceleration scenario. Valid values:

  • apiscene: API acceleration.
  • webservicescene: website acceleration.
  • staticscene: video, image, and text acceleration.
  • an empty string: no acceleration scenario is used.
apiscene
FunctionTypestring

Computing service type. Valid values:

  • routine
  • image
  • cloudFunction
routine

Examples

Sample success responses

JSONformat

{
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727",
  "DomainDetail": {
    "GmtCreated": "2017-11-27T06:51:26Z",
    "SSLPub": "xxx",
    "Description": "Beijing ICP Filing No. 1703xxxx\n",
    "SSLProtocol": "on",
    "ResourceGroupId": "rg-acfmyuji4b6r4**",
    "Scope": "overseas",
    "Cname": "example.aliyundoc.com",
    "DomainStatus": "online",
    "GmtModified": "2017-11-27T06:51:25Z",
    "DomainName": "example.com",
    "Sources": {
      "Source": [
        {
          "Type": "oss",
          "Weight": "20",
          "Enabled": "online",
          "Priority": "50",
          "Port": 80,
          "Content": "example.org"
        }
      ]
    },
    "Scene": "apiscene",
    "FunctionType": "routine"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-08-29The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.