SetLiveDomainCertificate - ApsaraVideo Live - Alibaba Cloud Documentation Center

Enables or disables the certificate for a domain name and modifies its information.

Operation description

First, obtain the live streaming domain name. Then, call this operation to enable or disable the certificate for the domain name and modify its certificate information.

QPS limit

This operation has a single-user limit of 30 queries per second (QPS). Calls that exceed this limit are throttled, which can affect your business. Call this operation at a reasonable rate.

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

update

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name for the certificate. This domain name must use HTTPS acceleration.	developer.aliyundoc.com
CertName	string	No	The certificate name.	Cert-****
CertType	string	No	The type of the certificate. Valid values: upload: An uploaded certificate. cas: A certificate from Certificate Management Service. free: A personal test certificate (Free Edition).	free
SSLProtocol	string	Yes	Specifies whether to enable the HTTPS certificate. Valid values: on: Enables the certificate. If you set this parameter to on, you must also set the SSLPub and SSLPri parameters. off (default): Disables the certificate.	off
SSLPub	string	No	The content of the public key. Note This parameter is required only when SSLProtocol is set to on.	****
SSLPri	string	No	The content of the private key. Note This parameter is required only when SSLProtocol is set to on.	****
ForceSet	string	No	Set the value to 1 to ignore the check for duplicate certificate names and overwrite an existing certificate that has the same name.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSSLProtocol.ValueNotSupported	The specified value of parameter SSLProtocol is not supported.
400	SSLPub.MissingParameter	An input parameter "SSLPub" that is mandatory for processing the request is not supplied.
400	SSLPri.MissingParameter	An input parameter "SSLPri" that is mandatory for processing the request is not supplied.
400	InvalidSSLPub	The SSLPub you provided is malformed!
400	InvalidSSLPri	The SSLPri you provided is malformed!
400	Certificate.MissMatch	The SSLPri does not math the specified Certificate!
400	InvalidCertificate.TooLong	The Certificate you provided is over the max length!
400	InvalidCertName.TooLong	The Certificate name you provided is over the max length 128!
400	IllegalOperationDomain	You are not authorized to operate the domain.
400	Certificate.NotPermittedOff	Turn off certificate will change domain scheduling, please contact customer service
400	Certificate.SettedNotEffect	Certificate was successfully setted but does't take effect for protecting current service, please contact customer service
400	Certificate.NotFind	Not find the certificate info.
400	AuthenticationFailed	Authentication failed.
400	SetDomainCertificate.ParameterError	Parameters have error.
400	InvalidSSLPubOrInvalidSSLPri	The SSLPri or SSLPub you provided is malformed!
400	Certificate.StatusError	Certificate is not exist or its status is error.
400	DeleteFailed	Delete certificate is failed.
400	Certificate.Duplicated	The certificate name is duplicated.
400	Certificate.FormatError	The certificate format is error.
400	Certificate.KeyNull	The private key is not null.
400	Key.Malformed	The private key format is error.
400	CertStorage.failed	The certificate storage failed.
400	CertificateContent.Duplicated	The certificate is already uploaded, please don't upload again.
400	Certificate.Expired	The certificate is expired.
400	InvalidDomain.notOnline	The domain is not online, please check the domain status and try again later.
400	Decode.Error	The certificate sslpub or sslpri decode error.
400	sslPub.Error	The SSLPub encoded failed.
400	sslPri.Error	The SSLPri encoded failed.
400	DomainInSafeMode	This domain is in the safe mode. if you want to do this operation, please contact us!
400	DomainInProtectedMode	This domain is in the protected mode. if you want to do this operation, please contact us!
400	FunctionMutex	Function is mutex with other function.
400	DomainOffline	The domain is not online, please check the domain status and try again later.	The domain is not online, please check the domain status and try again later.
403	IllegalOperation	Illegal domain operate is not permitted.
404	CertName.MissingParameter	The CertName parameter is required.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.