DescribeLiveCertificateList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the certificates of one or more specified domain names or all certificates within your Alibaba Cloud account.

Operation description

If you specify one or more domain names in the request, the certificates of the domain names are returned. If you do not specify a domain name in the request, all certificates within your Alibaba Cloud account are returned.

QPS limit

You can call this operation up to 50 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.

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:DescribeLiveCertificateList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The ingest domain or streaming domain. Separate multiple domain names with commas (,).	demo.aliyundoc.com,example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
CertificateListModel	object	The details.
Count	integer	The number of certificates.	2
CertList	object
Cert	array<object>	The certificates.
	object	The information about the certificate.
LastTime	integer	The time when the certificate was issued. Unit: seconds.	1512388659
Fingerprint	string	The fingerprint of the certificate.	****
CertName	string	The name of the certificate.	Cert-****
Issuer	string	The certificate authority (CA) that issued the certificate.	*****
CertId	integer	The ID of the certificate.	123456
Common	string	The Common Name (CN) attribute of the certificate.	example.net

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "CertificateListModel": {
    "Count": 2,
    "CertList": {
      "Cert": [
        {
          "LastTime": 1512388659,
          "Fingerprint": "****",
          "CertName": "Cert-****",
          "Issuer": "*****",
          "CertId": 123456,
          "Common": "example.net"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.