All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveDomainByCertificate

Last Updated:Nov 07, 2023

Queries the accelerated domain names that match the certificate.

Usage notes

You can call this operation to query the accelerated domain names that match the certificate.

QPS limit

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

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

DescribeLiveDomainByCertificate

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

SSLPub

String

Yes

******

The public key of the SSL certificate. You must Base64-encode the public key before you invoke the encodeURIComponent function to encode a URI component. The public key must be in the PEM format.

SSLStatus

Boolean

No

true

Specifies whether to return only domain names with HTTPS enabled or disabled.

  • true: returns only domain names with HTTPS enabled.

  • false: return only domain names with HTTPS disabled.

Response parameters

Parameter

Type

Example

Description

RequestId

String

ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D

The request ID.

CertInfos

Array of CertInfo

The information about the certificate.

CertInfo

CertExpireTime

String

Nov 29 00:00:00 2016 GMT

The time when the certificate expires.

CertStartTime

String

Nov 29 23:59:59 2017 GMT

The time when the certificate became effective.

CertType

String

RSA

The type of the certificate. Valid values: RSA, DSA, and ECDSA.

CertSubjectCommonName

String

owner

The name of the SSL certificate owner.

CertCaIsLegacy

String

yes

Indicates whether the SSL certificate is obsolete. Valid values:

  • yes

  • no

DomainNames

String

*.example.com,aliyundoc.com

The domain names (DNS fields) that match the SSL certificate. Multiple domain names are separated by commas (,).

CertExpired

String

yes

Indicates whether the certificate has expired. Valid values:

  • yes

  • no

Issuer

String

C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1

The certificate authority (CA) that issued the certificate.

DomainList

String

example.com,aliyundoc.com

The list of domain names. If a value is returned, the value matches the SSL certificate. Multiple domain names are separated by commas (,).

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainByCertificate
&SSLPub=******
&SSLStatus=true
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveDomainByCertificateResponse>
    <RequestId>ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D</RequestId>
    <CertInfos>
        <CertExpireTime>Nov 29 00:00:00 2016 GMT</CertExpireTime>
        <CertStartTime>Nov 29 23:59:59 2017 GMT</CertStartTime>
        <CertType>RSA</CertType>
        <CertSubjectCommonName>owner</CertSubjectCommonName>
        <CertCaIsLegacy>yes</CertCaIsLegacy>
        <DomainNames>*.example.com,aliyundoc.com</DomainNames>
        <CertExpired>yes</CertExpired>
        <Issuer>C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1</Issuer>
        <DomainList>example.com,aliyundoc.com</DomainList>
    </CertInfos>
</DescribeLiveDomainByCertificateResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D",
  "CertInfos" : [ {
    "CertExpireTime" : "Nov 29 00:00:00 2016 GMT",
    "CertStartTime" : "Nov 29 23:59:59 2017 GMT",
    "CertType" : "RSA",
    "CertSubjectCommonName" : "owner",
    "CertCaIsLegacy" : "yes",
    "DomainNames" : "*.example.com,aliyundoc.com",
    "CertExpired" : "yes",
    "Issuer" : "C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1",
    "DomainList" : "example.com,aliyundoc.com"
  } ]
}

Error codes

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