All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnIpaDomainDetail

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:DescribeDcdnIpaDomainDetailRead
  • IpaDomain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain names for which you want to query basic information. You can specify only one domain name in each request.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The details about the accelerated domain name.

GmtCreatedstring

The creation time.

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

The public key of the certificate if HTTPS is enabled.

SSLPub
Descriptionstring

The description.

audit failed
SSLProtocolstring

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

  • on
  • off.
on
ResourceGroupIdstring

The ID of the resource group.

rg-acfmyuji4b6xxxx
CertNamestring

Indicates the name of the certificate if the HTTPS protocol is enabled.

yourCertName
Scopestring

The acceleration region. Valid values:

  • domestic: Chinese mainland
  • overseas: outside the Chinese mainland
  • global: global
overseas
Cnamestring

The CNAME assigned to the domain name.

example.com
DomainStatusstring

The status of the accelerated domain name. Valid values:

  • online: enabled
  • offline: disabled
  • configuring: configuring
  • configure_failed: configuration failed
  • checking: reviewing
  • check_failed: review failed
online
GmtModifiedstring

The time when the domain name was last modified.

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

The accelerated domain names.

example.com
Sourcesobject []

The information about the origin server.

Typestring

The type of the origin server. Valid values:

  • ipaddr: an origin IP address
  • domain: a domain name.
  • oss: Object Storage Service (OSS) buckets are not supported.
oss
Weightstring

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

10
Enabledstring

The status.

online
Prioritystring

The priority.

50
Portinteger

The custom port. Valid values: 0 to 65535.

80
Contentstring

The address of the origin server.

xxx.oss-cn-hangzhou.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727",
  "DomainDetail": {
    "GmtCreated": "2017-11-27T06:51:26Z",
    "SSLPub": "SSLPub",
    "Description": "audit failed",
    "SSLProtocol": "on",
    "ResourceGroupId": "rg-acfmyuji4b6xxxx",
    "CertName": "yourCertName",
    "Scope": "overseas",
    "Cname": "example.com",
    "DomainStatus": "online",
    "GmtModified": "2017-11-27T06:51:26Z",
    "DomainName": "example.com",
    "Sources": {
      "Source": [
        {
          "Type": "oss",
          "Weight": "10",
          "Enabled": "online",
          "Priority": "50",
          "Port": 80,
          "Content": "xxx.oss-cn-hangzhou.aliyuncs.com"
        }
      ]
    }
  }
}

Error codes

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