1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to upload a certificate.
A maximum of 10 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: UploadCertificate. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-12-05. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| CertificatePublicKey |
Yes |
String |
Public key of the certificate |
| CertificatePrivateKey |
No |
String |
Private key content. This parameter is required when the certificate type is SVR, and not required when the certificate type is CA. |
| CertificateType |
No |
String |
Certificate type. Valid values: CA (CA certificate) and SVR (server certificate). Default value: SVR |
| Alias |
No |
String |
Alias |
| ProjectId |
No |
Integer |
Project ID |
| CertificateUse |
No |
String |
Certificate Usage/Source, such as CLB, CDN, WAF, LIVE, DDOS. |
| Tags.N |
No |
Array of Tags |
The list of tags. |
| Repeatable |
No |
Boolean |
Whether to allow duplicate upload of the same certificate, true: allow uploading certificates with the same fingerprint; false: do not allow uploading certificates with the same fingerprint. default value: true. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| CertificateId |
String |
Certificate ID |
| RepeatCertId |
String |
The ID of the repeatedly uploaded certificate.
Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Upload CA Certificate
Upload the root certificate
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadCertificate
<Common request parameters>
{
"CertificatePublicKey": "-----BEGIN CERTIFICATE-----\nxxxxxxxxxxxxxxxxxxx\n-----END CERTIFICATE-----",
"Alias": "Upload CA Certificate"
"ProjectId": "1634827",
"Repeatable": false,
"CertificateType": "CA",
"Tags": [
{
"TagKey": "key1",
"TagValue": "value1"
},
{
"TagKey": "key2",
"TagValue": "value2"
}
]
}
Output Example
{
"Response": {
"CertificateId": "a92b1Z1i",
"RepeatCertId": "",
"RequestId": "7ef2d2bb-f609-4e3d-a35c-04a5d3ac633b"
}
}
Example2 Upload Server-Side Certificate
Upload the server-side certificate
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadCertificate
<Common request parameters>
{
"CertificatePublicKey": "-----BEGIN CERTIFICATE-----\nxxxxxxxxxxxxxxxxxxx\n-----END CERTIFICATE-----",
"CertificatePrivateKey": "-----BEGIN RSA PRIVATE KEY-----\r\nxxxxxxxxxxxxxxxxxxxxxxxx\r\n-----END RSA PRIVATE KEY-----",
"Alias": "Upload Certificate"
"ProjectId": "1647838",
"Repeatable": false,
"CertificateType": "SVR",
"Tags": [
{
"TagKey": "key1",
"TagValue": "value1"
},
{
"TagKey": "key2",
"TagValue": "value2"
}
]
}
Output Example
{
"Response": {
"CertificateId": "DSAuy46E",
"RepeatCertId": "DSAuy46E",
"RequestId": "6d69e2d8-2c31-40d2-a244-9f86ffb20cd0"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| AuthFailure |
A CAM signature/authentication error occurred. |
| AuthFailure.UnauthorizedOperation |
The operation is unauthorized. |
| FailedOperation |
Operation failed. |
| FailedOperation.AuthError |
You do not have permission to perform this operation. |
| FailedOperation.CAMAuthorizedFail |
A CAM authentication error occurred. |
| FailedOperation.CancelOrderFailed |
Failed to cancel the order. |
| FailedOperation.CannotBeDeletedIssued |
Failed to delete the certificate because it has been issued. |
| FailedOperation.CannotBeDeletedWithinHour |
Free certificates cannot be deleted within 1 hour after being applied for. |
| FailedOperation.CannotGetOrder |
Failed to get order information. Try again later. |
| FailedOperation.CertificateCaError |
Note: the uploaded certificate content does not conform to the standard format of ca certificates. please check whether the certificate type is incorrect. |
| FailedOperation.CertificateEncryptInvalid |
The certificate is suspected to be an SM2 certificate and does not comply with the selected certificate standard. Please check whether the selected certificate standard and the content of the certificate are correct. |
| FailedOperation.CertificateExists |
The certificate already exists. |
| FailedOperation.CertificateInvalid |
The certificate is invalid. |
| FailedOperation.CertificateMatchError |
Note: the certificate content and private key do not match. please check (pay attention to whether there are extra spaces). |
| FailedOperation.CertificateMismatch |
The certificate and the private key do not match. |
| FailedOperation.CertificateNotFound |
The certificate does not exist. |
| FailedOperation.CertificateParseError |
Parsing failed. check if the certificate meets the standard and pay attention to whether there are extra spaces. |
| FailedOperation.ExceedsFreeLimit |
The number of free certificates exceeds the maximum value. |
| FailedOperation.InvalidCertificateStatusCode |
The certificate status is incorrect. |
| FailedOperation.InvalidParam |
Incorrect parameters. |
| FailedOperation.NetworkError |
The CA system is busy. Try again later. |
| FailedOperation.NoProjectPermission |
You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth |
You have not completed the identity verification. |
| FailedOperation.OrderAlreadyReplaced |
This order has already been replaced. |
| FailedOperation.OrderReplaceFailed |
Failed to reissue a certificate. |
| InternalError |
Internal error. |
| InvalidParameter.MissMatchPrivateKey |
There is no matching private key. |
| InvalidParameter.WithDetailReason |
The parameter is incorrect. |
| LimitExceeded.RateLimitExceeded |
The API rate limit is reached. |