DescribeLiveDomainByCertificate - ApsaraVideo Live - Alibaba Cloud Documentation Center

Retrieves accelerated domain names based on certificate information.

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

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
SSLPub	string	Yes	The public key of the SSL certificate, in PEM format. The value must be Base64 encoded and then URL encoded (encodeURIComponent) before being submitted.	******
SSLStatus	boolean	No	Specifies whether to return only domain names with HTTPS enabled or disabled. true: returns only domain names with HTTPS enabled. false: returns only domain names with HTTPS disabled.	true

Response elements

Parameter	Type	Description	Example
	object	The returned data.
CertInfos	object
CertInfo	array<object>	The certificates.
	object	The details of a certificate.
CertCaIsLegacy	string	Indicates if the Certificate Authority (CA) is deprecated. yes no	yes
CertExpireTime	string	The expiration time of the certificate.	Nov 29 00:00:00 2016 GMT
CertExpired	string	Indicates if the certificate has expired. Valid values: yes no	yes
CertStartTime	string	The start time of the certificate validity period.	Nov 29 23:59:59 2017 GMT
CertSubjectCommonName	string	The Common Name (CN) from the certificate's subject field.	owner
CertType	string	The type of the certificate. Valid values: RSA, DSA, and ECDSA.	RSA
DomainList	string	The domain names that match the specified certificate. Multiple domain names are separated by commas (,).	example.com,aliyundoc.com
DomainNames	string	The domain names that the certificate is authorized to secure in the Subject Alternative Name (SAN) field. Multiple domain names are separated by commas (,).	*.example.com,aliyundoc.com
Issuer	string	The distinguished name of the certificate issuer.	C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1
RequestId	string	The request ID.	ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.