All Products
Search

This Product

    CDN:DescribeDomainCertificateInfo

    Document Center

    CDN:DescribeDomainCertificateInfo

    Last Updated:Mar 28, 2024

    Queries the certificate information of 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
    cdn:DescribeDomainCertificateInfoREAD
    • Domain
      acs:cdn:*:{#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.

    CertExpireTimestring

    The time at which the certificate expires.

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

    The unit of the validity period of the certificate. Valid values:

    • months
    • years
    		months
    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 Alibaba Cloud CDN.
    • cname_error: No valid CNAME record has been added for the domain name.
    • top_domain_cname_error: No valid CNAME record has been added for the top-level domain.
    • domain_invalid: The domain name contains invalid characters.
    • unsupport_wildcard: The domain name is a wildcard domain name. Wildcard domain names are not supported.
    • applying: The 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
    CertUpdateTimestring

    The time at which the certificate was updated.

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

    The domain name that matches the certificate.

    		example.com
    ServerCertificateStatusstring

    The status of HTTPS.

    • on
    • off
    		on
    CertOrgstring

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

    		Let's Encrypt
    DomainNamestring

    The accelerated domain name.

    		example.com
    CertStartTimestring

    The time when the certificate became effective.

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

    The type of the certificate.

    • free: a free certificate
    • cas: a certificate that is purchased by using Certificate Management Service
    • upload: a custom certificate that you upload
    		free
    CertNamestring

    The name of the certificate.

    		example.com
    DomainCnameStatusstring

    The CNAME status of the domain name.

    • ok: The domain name points to the CNAME assigned by Alibaba Cloud CDN.
    • cname_error: An error occurred and the domain name cannot point to the CNAME.
    • op_domain_cname_error : An error occurred to the CNAME of the top-level domain. The domain name cannot point to the CNAME.
    • unsupport_wildcard: The wildcard domain name is not supported.
    		ok
    ServerCertificatestring

    The public key of the certificate.

    		asdadaxxxx
    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": [
      {
        "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",
        "CertId": "9002448",
        "CertRegion": "cn-hangzhou"
      }
    ]
  }
}

    Error codes

    HTTP status 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 Service error codes.