DescribeLiveDomainCertificateInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries certificate information about a domain name.

Operation description

Obtain a domain name, and then call this operation to query certificate information about the domain name.

QPS limit

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveDomainCertificateInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain or ingest domain.	example.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5C1E43DC-9E51-4771-82C0-7D5ECEB547A1
CertInfos	array<object>	The certificate information.
CertInfo	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. If the certificate is not a free certificate for testing, an empty value is returned.	success
CertLife	string	The validity period of the certificate. If the validity period is greater than 12 months, XX years XX months is displayed. For example, 2 years 3 months indicates that the validity period is 2 years and 3 months. If the validity period is less than 12 months, XX months is displayed. For example, 3 months indicates that the validity period is 3 months.	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	The status of HTTPS. Valid values: on: HTTPS is enabled. off: HTTPS is disabled.	on
CertType	string	The type of the certificate. Valid values: free: a free certificate (for testing) cas: a certificate that is 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 name of the certificate.	Cert-****
CertOrg	string	The certificate authority (CA) that issued the certificate.	Let's Encrypt
DomainName	string	The streaming domain or ingest domain.	example.com

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-29	API Description Update	View Change Details