Enables or disables the certificate for a domain name and updates the certificate information.
Operation description
- You can call this operation up to 30 times per second per account.
- Method: POST.
Debugging
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:SetCdnDomainSSLCertificate | update | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The accelerated domain name for which you want to configure the SSL certificate. The type of request supported by the domain name must be HTTPS. You can specify only one domain name in each request. | example.com |
| CertName | string | No | The name of the SSL certificate. You can specify only one certificate name. | yourCertName |
| CertId | long | No | The ID of the certificate. | 8089870 |
| CertType | string | No | The type of the certificate.
| upload |
| SSLProtocol | string | Yes | Specifies whether to enable the SSL certificate.
| off |
| 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. | xxx |
| SSLPri | string | No | The private key. Specify the private key only if you want to enable the SSL certificate. | y**** |
| CertRegion | string | No | The region ID of the certificate. Valid values: cn-hangzhou and ap-southeast-1. Default value: cn-hangzhou. | cn-hangzhou |
| Env | string | No | Specifies whether the certificate is issued in canary releases. If you set this parameter to staging, the certificate is issued in canary releases. If you do not specify this parameter or set this parameter to other values, the certificate is officially issued. | staging |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "A7C69682-7F88-40DD-A198-10D0309E439D\n"
}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 maximum length of the certificate is exceeded. | - |
| 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 | CreateCertificateFailed | Create certificate failed,please try again. | - |
| 400 | Abs.CertRegion.ValueNotSupported | CertRegion is not supported. | The certificate region is not supported. |
| 403 | DomainInProtectedMode | The domain is in protection mode. To request permission, contact Customer Service. | - |
| 404 | CertName.MissingParameter | You must specify CertName. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-28 | The Error code has changed | View Change Details |
| 2024-05-07 | The Error code has changed | View Change Details |
| 2023-12-06 | The Error code has changed | View Change Details |
| 2023-09-04 | The Error code has changed. The request parameters of the API has changed | View Change Details |