Enables, disables, or configures the SSL certificates of one or more accelerated domain names at a time.
Operation Description
- You can call this operation up to 10 times per second per account.
- You can specify up to 10 domain names in each request. Separate multiple domain names with commas (,)
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cdn:BatchSetCdnDomainServerCertificate | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The accelerated domain name to which the SSL certificate belongs. The type of request supported by the accelerated domain name must be HTTPS. You can specify multiple accelerated domain names and separate them with commas (,). NoteYou can configure up to 10 domain names at a time. | example.com |
| CertName | string | No | The name of the certificate. | yourCertName |
| CertType | string | No | The type of the certificate. Valid values:
| cas |
| SSLProtocol | string | Yes | Specifies whether to enable the SSL certificate. Default value: off. Valid values:
| on |
| SSLPub | string | No | The content of the SSL certificate. Specify the content of the SSL certificate only if you want to enable the SSL certificate. | yourSSLPub |
| SSLPri | string | No | The private key. Specify the private key only if you want to enable the SSL certificate. | yourSSLPri |
| Region | string | No | The ID of the region. | your region |
| ForceSet | string | No | Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information about the existing certificate that uses the same name. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidSSLProtocol.ValueNotSupported | The specified SSLProtocol is invalid. | - |
| 400 | SSLPub.MissingParameter | The SSLPub parameter is required. | - |
| 400 | SSLPri.MissingParameter | The SSLPri parameter is required. | - |
| 400 | InvalidSSLPub | The specified SSLPub is invalid. | - |
| 400 | InvalidSSLPri | The specified SSLPri is invalid. | - |
| 400 | Certificate.MissMatch | The SSLPri does not match the certificate. | - |
| 400 | InvalidCertificate.TooLong | The Certificate you provided is over the max length | Certificate and private key length exceeds the limit |
| 400 | InvalidCertName.TooLong | The length of the certificate name cannot exceed 128 characters. | - |
| 400 | IllegalOperationDomain | You are not authorized to operate the domain. | You are not authorized to manage the domain name. |
| 400 | AuthenticationFailed | Error performing verification. | - |
| 400 | SetDomainCertificate.ParameterError | The specified parameters are invalid. | The specified parameter is invalid. |
| 400 | Certificate.StatusError | The status of the certificate is invalid. | - |
| 400 | DeleteFailed | Error deleting the certificate. | - |
| 400 | Certificate.NotFind | The certificate does not exist. | - |
| 400 | Certificate.Duplicated | The certificate name already exists. | - |
| 400 | Certificate.FormatError | The format of the certificate is invalid. | The specified certificate is invalid. |
| 400 | Certificate.StatusError | The certificate does not exist, or the status of the certificate is invalid. | - |
| 400 | Certificate.KeyNull | The private key is required. | - |
| 400 | Key.Malformed | The specified Key format is invalid. | - |
| 400 | CertStorage.failed | Error saving the certificate. | - |
| 400 | CertificateContent.Duplicated | The certificate has been uploaded; do not upload again. | - |
| 400 | Certificate.Expired | The certificate has expired. | - |
| 400 | InvalidDomain.notOnline | The domain is offline. Check the status of the domain and try again later. | - |
| 400 | Decode.Error | Error decoding the SSLPub or SSLPri certificate. | - |
| 400 | sslPub.Error | Error encoding SSLPub. | - |
| 400 | sslPri.Error | Error encoding SSLPri. | - |
| 400 | DomainInSafeMode | The domain is in safe mode. To request permission, contact Customer Service. | - |
| 400 | InvalidDomainNumber.TooLong | The number of the DomainNumber cannot exceed 10. | - |
| 403 | DomainInProtectedMode | The domain is in protection mode. To request permission, contact Customer Service. | - |
| 404 | CertName.MissingParameter | The CertName parameter is required. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-03-24 | The error codes of the API operation change. | |||||||||
|