Queries certificate information about a domain name.

Usage notes

Obtain an ApsaraVideo Live domain name, and then call this operation to query certificate information about the domain name.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveDomainCertificateInfo

The operation that you want to perform. Set the value to DescribeLiveDomainCertificateInfo.

DomainName String Yes example.com

The streaming domain or ingest domain.

Response parameters

Parameter Type Example Description
RequestId String 5C1E43DC-9E51-4771-82C0-7D5ECEB547A1

The ID of the request.

CertInfos Array of CertInfo

The certificate information.

Status String success

The status of the free certificate. Valid values:

  • success: The certificate is effective.
  • checking: The system is checking whether the domain name is mapped to the CNAME that is assigned by ApsaraVideo Live.
  • cname_error: The domain name is not mapped to the CNAME that is assigned by ApsaraVideo Live.
  • domain_invalid: The domain name contains invalid characters.
  • unsupport_wildcard: The wildcard domain name is not supported.
  • applying: The certificate is in the application progress.
  • failed: The application for the certificate failed.
Note The status parameter is valid only if the certificate is a free certificate. If the certificate is not free, an empty value is returned.
CertLife String 3 months

The validity period of the certificate.

  • If the validity period is greater than 12 months, XX years XX months is displayed. For example, 2 years 3 months indicates that the validity period is 2 years and 3 months.
  • If the validity period is less than 12 months, XX months is displayed. For example, 3 months indicates that the validity period is 3 months.
CertExpireTime String 2018-06-03T22:03:39Z

The time at which the certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

SSLPub String yourSSLPub

The public key of the certificate.

SSLProtocol String on

The status of HTTPS. Valid values: Valid values:

  • on: HTTPS is enabled.
  • off: HTTPS is disabled.
CertType String cas

The type of the certificate. Valid values:

  • free: a free certificate
  • cas: a certificate that is purchased from Alibaba Cloud SSL Certificates Service
  • upload: a custom certificate that you upload
CertDomainName String example.com

The streaming domain or ingest domain that matches the certificate.

CertName String Cert-****

The name of the certificate.

CertOrg String Let's Encrypt

The certificate authority (CA) that issued the certificate.

DomainName String example.com

The streaming domain or ingest domain.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8" ?>
        <CertLife>3 months</CertLife>
        <CertOrg>Let's Encrypt</CertOrg>

JSON format

HTTP/1.1 200 OK

  "SetLiveDomainCertificateResponse" : {
    "CertInfos" : {
      "CertInfo" : {
        "Status" : "success",
        "CertLife" : "3 months",
        "DomainName" : "example.com",
        "SSLPub" : "yourSSLPub",
        "CertOrg" : "Let's Encrypt",
        "CertDomainName" : "example.com",
        "CertType" : "cas",
        "CertExpireTime" : "2018-06-03T22:03:39Z",
        "CertName" : "Cert-****",
        "SSLProtocol" : "on"
    "RequestId" : "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1"

Error codes

For a list of error codes, see Service error codes.

Special error codes

Error code

Error message

HTTP status code



The domain provided does not belong to you.


The error message returned because the specified domain name does not exist or does not belong to the current account.