All Products
Search
Document Center

ApsaraVideo VOD:SetVodDomainCertificate

Last Updated:May 11, 2024

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

Operation description

Note This operation is available only in the China (Shanghai) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:SetVodDomainCertificateRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

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

example.com
CertNamestringNo

The name of the certificate.

cert_name
SSLProtocolstringYes

Specifies whether to enable the SSL certificate. Default value: off. Valid values:

  • on
  • off
off
SSLPubstringNo

The content of the certificate. This parameter is required only if you enable the SSL certificate.

****
SSLPristringNo

The private key. This parameter is required only if you enable the SSL certificate.

****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

04F0F334-1335-436C-****-6C044FE73368

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-****-6C044FE73368"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history

Common errors

The following table describes the error codes that this operation can return.

Error codeError messageHTTP status codeDescription
InvalidDomain.NotFoundThe domain provided does not belong to you.404The error message returned because the specified domain name does not exist or does not belong to the current account.
IllegalOperationIllegal domain operate is not permitted.403The error message returned because you are not authorized to perform this operation.
ServiceBusyThe specified Domain is configuring, please retry later.403The error message returned because the domain name is being configured. Try again later.
InvalidDomain.OfflineThe domain provided is offline.400The error message returned because the domain name is disabled.
OperationDeniedYour CDN service is suspended.403The error message returned because your Alibaba Cloud account has overdue payments. Add funds to your account.
InvalidSSLProtocol.ValueNotSupportedThe specified value of parameter Enable is not supported.400The error message returned because the value of the SSLProtocol parameter is invalid.
SSLPub.MissingParameterAn input parameter SSLPub that is mandatory for processing the request is not supplied.400The error message returned because the SSLPub parameter is not specified.
SSLPri.MissingParameterAn input parameter SSLPri that is mandatory for processing the request is not supplied.400The error message returned because the SSLPri parameter is not specified.
InvalidCertificateThe Certificate you provided is malformed!400The error message returned because the certificate content is invalid.
InvalidSSLPriThe SSLPri you provided is malformed!400The error message returned because the private key is invalid.
Certificate.MissMatchThe SSLPri does not math the specified Certificate!400The error message returned because the certificate and the private key do not match.
InvalidCertificate.TooLongThe Certificate you provided is over the max length!400The error message returned because the length of the certificate content exceeds the upper limit.
InvalidCertName.TooLongThe Certificate name you provided is over the max length 128!400The error message returned because the certificate name contains more than 128 characters.
SetDomainSSLPub.ParameterErrorParameters have error.400The error message returned because one or more parameters are invalid.
Certificate.StatusErrorCertificate is not exist or its status is error.400The error message returned because the certificate does not exist or the certificate status is invalid.
DeleteFailedDelete certificate is failed.400The error message returned because the system failed to delete the specified certificate.
Certificate.NotFindNot find the certificate info.400The error message returned because the certificate was not found.
Certificate.DuplicatedThe certificate name is duplicated.400The error message returned because the certificate name already exists.
Certificate.FormatErrorThe certificate format is error.400The error message returned because the certificate format is invalid.
Certificate.StatusErrorThe certificate status is error.400The error message returned because the certificate status is invalid.
Certificate.KeyNullThe SSLPri is not null.400The error message returned because the private key is not specified.
SSLPri.MalformedThe SSLPri format is error.400The error message returned because the format of the private key is invalid.
Certificate.NotPermittedOffTurn off certificate will change domain scheduling, please contact customer service.400The error message returned because disabling the certificate may affect the scheduling of the domain name. Contact Customer Service.
Certificate.SettedNotEffectCertificate was successfully set but doesn't take effect for protecting current service, please contact customer service.400The error message returned because the certificate is configured but temporarily disabled to protect your service. To enable the certificate, contact Customer Service.