DescribeLiveHttpsDomainList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries information about all certificates configured in Certificate Service.

Operation description

You can call this operation to query information about all configured certificates and domain names in Certificate Service.

QPS limit

You can make up to 100 queries per second (QPS). If you exceed this limit, your API calls are throttled. This may affect your business. We recommend that you call this operation at a reasonable frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveHttpsDomainList

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
PageNumber	integer	No	The page number to return. Valid values: [1,10000].	5
PageSize	integer	No	The number of entries to return on each page. The default value is 20.	20
Keyword	string	No	The accelerated domain name.	demo.aliyun.com

Response elements

Element	Type	Description	Example
	object	The returned parameters.
CertInfos	object
CertInfo	array<object>	The list of certificate information.
	object	The details of the certificates.
CertCommonName	string	The primary domain name of the certificate.	example.org
CertExpireTime	string	The expiration time of the certificate.	2018-12-26 14:45:09
CertName	string	The name of the certificate.	test
CertStartTime	string	The start time of the certificate.	2018-11-26 14:45:09
CertStatus	string	The status of the certificate. ok: Normal. mismatch: The domain name does not match the certificate. expired: The certificate has expired. expire_soon: The certificate is about to expire.	mismatch
CertType	string	The type of the certificate. cas: a certificate from Alibaba Cloud Certificate Service. upload: a custom certificate that you uploaded.	cas
CertUpdateTime	string	The time when the certificate was updated.	2019-01-08 18:33:16
DomainName	string	The accelerated domain name.	example.com
RequestId	string	The request ID.	F5E8DF64-7175-4186-9B06-F002C0BBD0C5
TotalCount	integer	The total number of entries.	16

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	NoHttpsDomain	Your account doesn't have https domain.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.