SetLiveDomainCertificate - ApsaraVideo Live

Usage notes

Obtain the domain name, and then call this operation to enable or disable the certificate of a domain name and modify the certificate information.

QPS limit

You can call this operation up to 30 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. For more information, see QPS limits.

Debugging

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`-based acceleration.
CertName	String	No	Cert-****	The certificate name.
CertType	String	No	free	The certificate type. Valid values: upload: a custom certificate cas: a certificate that is purchased from Certificate Management Service free: a free certificate (for testing)
SSLProtocol	String	Yes	off	Specifies whether to enable the HTTPS certificate. Valid values: on. If you set this parameter to on, you must also specify the SSLPub and SSLPri parameters. off. This is the default value.
SSLPub	String	No	****	The public key. Note This parameter is required only if you set the SSLProtocol parameter to on.
SSLPri	String	No	****	The private key. Note This parameter is required only if you set the SSLProtocol parameter 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 has the same name. Set the value to 1.

Response parameters

Parameter	Type	Example	Description
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	The request ID.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=SetLiveDomainCertificate
&DomainName=developer.aliyundoc.com
&SSLProtocol=off
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<SetLiveDomainCertificateResponse>
	<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>
</SetLiveDomainCertificateResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code	Error code	Error message	Description
403	IllegalOperation	Illegal domain operate is not permitted.	You do not have the permissions to call the operation. Contact the administrator to obtain the required access permissions.

For a list of error codes, see Service error codes.