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.
Debugging
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. |
|
CertInfo | |||
Status | String | success | The status of the free certificate. Valid values:
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.
|
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:
|
CertType | String | cas | The type of the certificate. Valid values:
|
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. |
Examples
Sample requests
http(s)://live.aliyundoc.com/?Action=DescribeLiveDomainCertificateInfo
&DomainName=example.com
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<SetLiveDomainCertificateResponse>
<CertInfos>
<CertInfo>
<Status>success</Status>
<CertLife>3 months</CertLife>
<DomainName>example.com</DomainName>
<SSLPub>yourSSLPub</SSLPub>
<CertOrg>Let's Encrypt</CertOrg>
<CertDomainName>example.com</CertDomainName>
<CertType>cas</CertType>
<CertExpireTime>2018-06-03T22:03:39Z</CertExpireTime>
<CertName>Cert-****</CertName>
<SSLProtocol>on</SSLProtocol>
</CertInfo>
</CertInfos>
<RequestId>5C1E43DC-9E51-4771-82C0-7D5ECEB547A1</RequestId>
</SetLiveDomainCertificateResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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 |
Description |
---|---|---|---|
InvalidDomain.NotFound |
The domain provided does not belong to you. |
404 |
The error message returned because the specified domain name does not exist or does not belong to the current account. |