Queries the certificate information about a domain name.

Debugging

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 www.yourdomain.com

The streaming domain.

RegionId String No cn-shanghai

The ID of the region where the streaming domain resides.

Response parameters

Parameter Type Example Description
CertInfos Array of CertInfo

The certificate information about the domain name.

CertInfo
CertDomainName String example.com

The domain name that matches the certificate.

CertExpireTime String 2018-06-03T22:03:39Z

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

CertLife String 3

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

CertName String Cert-****

The name of the certificate.

CertOrg String Let's Encrypt

The certificate authority (CA) that issued the certificate.

CertType String free

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 user-uploaded certificate.
DomainName String www.yourdomain.com

The streaming domain.

SSLProtocol String on

The status of HTTPS. Valid values:

  • on: HTTPS is enabled.
  • off: HTTPS is disabled.
SSLPub String yourSSLPub

The public key of the certificate.

Status String success

The status of the certificate. Valid values:

  • success: The certificate is effective.
  • checking: The system is checking whether the domain name is mapped to the canonical name (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: Wildcard domain names are not supported.
  • applying: The certificate is in the application progress.
  • failed: The application for the certificate has failed.
RequestId String 5C1E43DC-9E51-4771-82C0-7D5ECEB547A1

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=DescribeLiveDomainCertificateInfo
&DomainName=www.yourdomain.com
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveDomainCertificateInfoResponse>
  <CertInfos>
        <CertInfo>
              <Status>success</Status>
              <CertLife>3 months</CertLife>
              <SSLProtocol>on</SSLProtocol>
              <CertType>cas</CertType>
              <CertName>cert-example.com</CertName>
              <CertDomainName>example.com</CertDomainName>
              <DomainName>example.com</DomainName>
              <CertOrg>Let's Encrypt</CertOrg>
              <CertExpireTime>2018-06-03T22:03:39Z</CertExpireTime>
        </CertInfo>
  </CertInfos>
  <RequestId>5C1E43DC-9E51-4771-82C0-7D5ECEB547A1</RequestId>
</DescribeLiveDomainCertificateInfoResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.

Special error codes

Error code

Error message

HTTP status code

Description

InvalidDomain.NotFound

The domain provided does not belong to you.

404

The error message returned because the domain name does not exist or does not belong to you.