DescribeLiveDomainByCertificate - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the accelerated domain names that match a certificate.

Operation description

You can call this operation to query the accelerated domain names that match a certificate.

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:DescribeLiveDomainByCertificate	get	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SSLPub	string	Yes	The public key of the SSL certificate. You must Base64-encode the public key before you invoke the encodeURIComponent function to encode a URI component. The public key must be in the PEM format.	******
SSLStatus	boolean	No	Specifies whether to return only domain names with HTTPS enabled or disabled. true: returns only domain names with HTTPS enabled. false: The rule is disabled.	true

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
CertInfos	array<object>	The information about the certificate.
CertInfo	object
CertCaIsLegacy	string	Indicates whether the SSL certificate is obsolete. Valid values: yes no	yes
CertExpireTime	string	The time at which the certificate expires.	Nov 29 00:00:00 2016 GMT
CertExpired	string	Indicates whether the SSL certificate is expired. Valid values: yes no	yes
CertStartTime	string	The effective time of the certificate.	Nov 29 23:59:59 2017 GMT
CertSubjectCommonName	string	The name of the SSL certificate owner.	owner
CertType	string	The type of the certificate. Valid values: RSA, DSA, and ECDSA.	RSA
DomainList	string	The list of domain names. If a value is returned, the value matches the SSL certificate. Multiple domain names are separated by commas (,).	example.com,aliyundoc.com
DomainNames	string	The domain names (DNS fields) that match the SSL certificate. Multiple domain names are separated by commas (,).	*.example.com,aliyundoc.com
Issuer	string	The certificate authority (CA) that issued the SSL certificate.	C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1
RequestId	string	The ID of the request.	ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D

Examples

Sample success responses

JSONformat

{
  "CertInfos": {
    "CertInfo": [
      {
        "CertCaIsLegacy": "yes",
        "CertExpireTime": "Nov 29 00:00:00 2016 GMT",
        "CertExpired": "yes",
        "CertStartTime": "Nov 29 23:59:59 2017 GMT",
        "CertSubjectCommonName": "owner",
        "CertType": "RSA",
        "DomainList": "example.com,aliyundoc.com",
        "DomainNames": "*.example.com,aliyundoc.com",
        "Issuer": "C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1"
      }
    ]
  },
  "RequestId": "ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D"
}

Error codes

HTTP status code	Error code	Error message
400	Certificate.FormatError	The format of the certificate is invalid.
400	SSLPub.MissingParameter	The Cert parameter is required.
400	Decode.Error	Error decoding the SSLPub certificate.
400	Certificate.DecodeError	An error occurred while decoding the certificate.
500	InternalError	The request processing has failed due to backend service exception.

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. The Error code has changed	View Change Details