All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainCertificateInfo

Last Updated:Feb 28, 2024

Queries the certificate information about an accelerated domain name.

Operation description

Note You can call this operation up to 100 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:DescribeDcdnDomainCertificateInfoRead
  • domain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name in each request.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

5C1E43DC-9E51-4771-82C0-7D5ECEB547A1
CertInfosobject []

The information about the certificate.

Statusstring

The status of the certificate. Valid values:

  • success: The certificate has taken effect.
  • checking: The system is checking whether the domain name is using Dynamic Route for CDN (DCDN).
  • cname_error: The domain name is not using DCDN.
  • domain_invalid: The domain name contains invalid characters.
  • unsupport_wildcard: The wildcard domain name is not supported.
  • applying: Certificate application is in progress.
  • get_token_timeout: The certificate application request has timed out.
  • check_token_timeout: The verification has timed out.
  • get_cert_timeout: The request to obtain the certificate has timed out.
  • failed: The certificate application request failed.
success
CertLifestring

The validity period of the certificate. Unit: months or years.

3 months
CertExpireTimestring

The time at which the certificate expires.

2018-06-03T22:03:39Z
SSLPubstring

The public key of the certificate.

xxxx
SSLProtocolstring

The status of HTTPS. Valid values:

  • on
  • off
on
CertTypestring

The type of the certificate.

  • cas: a certificate that is purchased by using Certificates Management Service
  • upload: a custom certificate that you upload
cas
CertDomainNamestring

The domain name that matches the certificate.

example.com
CertNamestring

The name of the certificate.

cert-example.com
CertOrgstring

The certificate authority (CA) that issued the certificate.

Let's Encrypt
DomainNamestring

The accelerated domain name.

example.com
CertIdstring

The ID of the certificate.

9002448
CertRegionstring

The region where the certificate is used.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "Status": "success",
        "CertLife": "3 months",
        "CertExpireTime": "2018-06-03T22:03:39Z",
        "SSLPub": "xxxx",
        "SSLProtocol": "on",
        "CertType": "cas",
        "CertDomainName": "example.com",
        "CertName": "cert-example.com",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com",
        "CertId": "9002448",
        "CertRegion": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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