Enables or disables the Secure Sockets Layer (SSL) certificate for a specified domain name. When you call this operation to enable the SSL certificate, you can also modify the certificate information.

Usage note

Domain name is mandatory for enabling SSL or modifying the SSL certificate.

QPS limit

A single user can perform a maximum of 30 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SetLiveDomainCertificate

The operation that you want to perform. Set the value to SetLiveDomainCertificate.

DomainName String Yes developer.aliyundoc.com

The domain name that is secured by the certificate. The domain name uses HTTPS acceleration.

SSLProtocol String Yes off

Specifies whether to enable the SSL certificate. Valid values:

  • on: enables the SSL certificate.
  • off: disables the SSL certificate. This is the default value.
CertName String No Cert-****

The name of the certificate.

CertType String No free

The type of the certificate. Valid values: Valid values:

  • upload: an uploaded certificate.
  • cas: a certificate that is issued by SSL Certificates Service.
  • free: a free certificate.
SSLPub String No ****

The content of the certificate.

Note This parameter is required only if the SSLProtocol parameter is set to on.
SSLPri String No ****

The private key.

Note This parameter is required only if the SSLProtocol parameter is set to on.
ForceSet String No 1

Specifies whether to check the certificate name for duplicates. A value of 1 indicates that the system does not perform the check and overwrites the information about the certificate that uses the same name. Set the value to 1.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "SetLiveDomainCertificateResponse": {
        "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"

Error codes

HttpCode Error code Error message Description
403 IllegalOperation Illegal domain operate is not permitted. The error message returned because you do not have the permission to call this operation as a RAM user. Use the Alibaba Cloud account to grant the required permissions to the RAM user.

For a list of error codes, visit the API Error Center.