All Products
Search
Document Center

Alibaba Cloud CDN:DescribeDomainCertificateInfo

Last Updated:Jan 30, 2023

Queries the certificate information about an accelerated domain name.

Operation Description

NoteThe maximum number of times that each user can call this operation per second is 100.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
cdn:DescribeDomainCertificateInfoREAD
  • CDN
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

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

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

5C1E43DC-9E51-4771-82C0-7D5ECEB547A1
CertInfosarray

The information about the SSL certificate.

object
CertExpireTimestring

The time when the SSL certificate expires.

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

The unit of the validity period of the SSL certificate.

  • months: The validity period is measured in months.
  • years: The validity period is measured in years.
months
Statusstring

The status of the SSL certificate.

  • success: The SSL certificate is effective.
  • checking: The system is checking whether the domain name is accelerated by Alibaba Cloud CDN.
  • cname_error: The domain name is not accelerated by Alibaba Cloud CDN.
  • top_domain_cname_error: The top-level domain name is not an accelerated domain name.
  • domain_invalid: The domain name contains invalid characters.
  • unsupport_wildcard: Wildcard domain names are not supported.
  • applying: The application for a certificate is in progress.
  • fget_token_timeout: The application for a certificate timed out.
  • check_token_timeout: The verification timed out.
  • get_cert_timeout: The request to obtain the certificate timed out.
  • failed: The application for a certificate failed.
success
CertUpdateTimestring

The time when the certificate was renewed.

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

The domain name that matches the SSL certificate.

example.com
ServerCertificateStatusstring

The status of HTTPS.

  • on: enabled.
  • off: disabled.
on
CertOrgstring

The name of the certificate authority (CA) that issued the SSL certificate.

Let's Encrypt
DomainNamestring

The accelerated domain name.

example.com
CertStartTimestring

The time when the SSL certificate became effective.

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

The type of the SSL certificate. Valid values:

  • free: a free SSL certificate.
  • cas: an SSL certificate purchased from Alibaba Cloud SSL Certificates Service.
  • upload: a user-uploaded SSL certificate.
free
CertNamestring

The name of the SSL certificate.

example.com
DomainCnameStatusstring

The status of the CNAME of the domain name.

  • ok: The domain name points to the CNAME assigned from Alibaba Cloud Content Delivery Network (CDN).
  • cname_error: An error occurred and the domain name cannot point to the CNAME.
  • top_domain_cname_error: An error occurred to the CNAME of the top-level domain name. The domain name cannot point to the CNAME.
  • unsupport_wildcard: Wildcard domain names are not supported.
ok
ServerCertificatestring

The public key of the SSL certificate.

asdadaxxxx

Example

Normal return example

JSONFormat

{
  "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "CertExpireTime": "2018-06-03T22:03:39Z",
        "CertLife": "months",
        "Status": "success",
        "CertUpdateTime": "2018-06-03T22:03:39Z",
        "CertDomainName": "example.com",
        "ServerCertificateStatus": "on",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com",
        "CertStartTime": "2018-06-03T22:03:39Z",
        "CertType": "free",
        "CertName": "example.com",
        "DomainCnameStatus": "ok",
        "ServerCertificate": "asdadaxxxx"
      }
    ]
  }
}

Error codes

Http codeError codeError message
403SignatureDoesNotMatchThe signature we calculated does not match the one you provided. Please refer to the API reference about authentication for details.
500InternalErrorThe request processing has failed due to internal error.

For a list of error codes, visit the API error center.