All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveHttpsDomainList

Last Updated:Nov 07, 2023

Queries information about all certificates that you have configured.

Usage notes

You can call this operation to query information about all certificates that you have configured.

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

DescribeLiveHttpsDomainList

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

PageNumber

Integer

No

5

The number of the page to return. Valid values: [1,10000].

PageSize

Integer

No

20

The number of entries per page. Default value: 20.

Keyword

String

No

demo.aliyun.com

The accelerated domain name.

Response parameters

Parameter

Type

Example

Description

TotalCount

Integer

16

The total number of entries.

RequestId

String

F5E8DF64-7175-4186-9B06-F002C0BBD0C5

The request ID.

CertInfos

Array of CertInfo

The information about the certificate.

CertInfo

CertStartTime

String

2018-11-26 14:45:09

The time when the certificate became effective.

CertExpireTime

String

2018-12-26 14:45:09

The time when the certificate expires.

CertUpdateTime

String

2019-01-08 18:33:16

The time when the certificate was updated.

CertType

String

cas

The type of the certificate.

  • cas: a certificate that is purchased by using Certificate Management Service

  • upload: a custom certificate that you uploaded

CertName

String

test

The name of the certificate.

CertStatus

String

mismatch

The status of the certificate. Valid values:

  • ok: The certificate is working as expected.

  • mismatch: The certificate does not match the specified domain name.

  • expired: The certificate has expired.

  • expire_soon: The certificate will expire soon.

DomainName

String

example.com

The accelerated domain name.

CertCommonName

String

example.org

The primary domain name of the certificate.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveHttpsDomainList
&PageNumber=5
&PageSize=20
&Keyword=demo.aliyun.com
&Common request parameters

Sample success responses

XML format

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

<DescribeLiveHttpsDomainListResponse>
    <TotalCount>16</TotalCount>
    <RequestId>F5E8DF64-7175-4186-9B06-F002C0BBD0C5</RequestId>
    <CertInfos>
        <CertStartTime>2018-11-26 14:45:09</CertStartTime>
        <CertExpireTime>2018-12-26 14:45:09</CertExpireTime>
        <CertUpdateTime>2019-01-08 18:33:16</CertUpdateTime>
        <CertType>cas</CertType>
        <CertName>test</CertName>
        <CertStatus>mismatch</CertStatus>
        <DomainName>example.com</DomainName>
        <CertCommonName>example.org</CertCommonName>
    </CertInfos>
</DescribeLiveHttpsDomainListResponse>

JSON format

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

{
  "TotalCount" : 16,
  "RequestId" : "F5E8DF64-7175-4186-9B06-F002C0BBD0C5",
  "CertInfos" : [ {
    "CertStartTime" : "2018-11-26 14:45:09",
    "CertExpireTime" : "2018-12-26 14:45:09",
    "CertUpdateTime" : "2019-01-08 18:33:16",
    "CertType" : "cas",
    "CertName" : "test",
    "CertStatus" : "mismatch",
    "DomainName" : "example.com",
    "CertCommonName" : "example.org"
  } ]
}

Error codes

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