DescribeLiveDomainCertificateInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Retrieves the certificate information for a specified domain name.

Operation description

You must specify a domain name whose certificate information you want to query.

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.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain or ingest domain.	example.com

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5C1E43DC-9E51-4771-82C0-7D5ECEB547A1
CertInfos	object
CertInfo	array<object>	The certificate information.
	object
Status	string	The status of the free certificate that is used for testing. Valid values: success: The certificate is effective. checking: The system is checking whether the domain name is mapped to the CNAME that is assigned by ApsaraVideo Live. cname_error: The domain name is not mapped to the CNAME that is assigned by ApsaraVideo Live. domain_invalid: The domain name contains invalid characters. unsupport_wildcard: The domain name is a wildcard domain name, which is not supported. applying: The certificate is in the application progress. failed: The application for the certificate failed. Note The Status parameter is valid only if the certificate is a free certificate for testing. Otherwise, an empty value is returned.	success
CertLife	string	The validity period of the certificate.	3 months
CertExpireTime	string	The expiration time of the certificate. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-06-03T22:03:39Z
SSLPub	string	The public key of the certificate.	yourSSLPub
SSLProtocol	string	Indicates whether HTTPS is enabled. Valid values: on: Enabled. off: Disabled.	on
CertType	string	The type of the certificate. Valid values: free: a free certificate (for testing) cas: a certificate purchased from Certificate Management Service upload: a custom certificate that you uploaded	cas
CertDomainName	string	The streaming domain or ingest domain that matches the certificate.	example.com
CertName	string	The certificate name.	Cert-****
CertOrg	string	The certificate authority (CA).	Let's Encrypt
DomainName	string	The streaming domain or ingest domain.	example.com

Examples

Success response

JSON format

{
  "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "Status": "success",
        "CertLife": "3 months",
        "CertExpireTime": "2018-06-03T22:03:39Z",
        "SSLPub": "yourSSLPub",
        "SSLProtocol": "on",
        "CertType": "cas",
        "CertDomainName": "example.com",
        "CertName": "Cert-****",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.