1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to one-click update old certificate resources. This API is asynchronous. After calling it, if DeployRecordId is 0, it means the task is in progress. Repeat the request to this API. When the returned DeployRecordId is greater than 0, it means the task creation is successful. If it is not created successfully, an exception will be thrown.
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: UpdateCertificateInstance. |
| 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. |
| OldCertificateId |
Yes |
String |
The old certificate id for one-click update. by querying the cloud resources bound to this certificate id, and then updating these cloud resources with the new certificate. |
| ResourceTypes.N |
Yes |
Array of String |
Resource types that need to be deployed, with optional parameter values (lowercase): clb, cdn, waf, live, ddos, teo, apigateway, vod, tke, tcb, tse, cos. |
| CertificateId |
No |
String |
New certificate id for one-click update. if this parameter is not provided, the public key certificate and private key certificate must be provided. |
| ResourceTypesRegions.N |
No |
Array of ResourceTypeRegions |
List of regions where cloud resources need to be deployed. the cloud resource type of the supported region must be passed. valid values: clb, tke, apigateway, waf, tcb, tse, cos. |
| CertificatePublicKey |
No |
String |
If a public key certificate is uploaded, the private key certificate must also be uploaded, and the CertificateId does not need to be transmitted. |
| CertificatePrivateKey |
No |
String |
If a private key certificate is uploaded, then a public key certificate must be uploaded; CertificateId is not required. |
| ExpiringNotificationSwitch |
No |
Integer |
Whether to ignore expiration reminder for old certificate 0: do not ignore the notification. 1: ignore the notification, ignore the expiration reminder of OldCertificateId. |
| Repeatable |
No |
Boolean |
It specifies whether the same certificate is allowed to be uploaded repeatedly. If the public key and private key certificates are selected for upload, this parameter can be configured. If there are duplicate certificates, the update task will fail. |
| AllowDownload |
No |
Boolean |
Whether to allow downloading. If you choose to upload a public/private key certificate, this parameter can be configured. |
| Tags.N |
No |
Array of Tags |
Tag list. If you choose to upload a public/private key certificate, you can configure this parameter. |
| ProjectId |
No |
Integer |
Project id. If you choose to upload a public/private key certificate, you can configure this parameter. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| DeployRecordId |
Integer |
Task id, DeployRecordId of 0 indicates that the task is in progress. repeatedly requesting this api, when DeployRecordId returned is greater than 0, it indicates that the task is created successfully. if not created successfully, an exception will be thrown.
Note: this field may return null, indicating that no valid values can be obtained. |
| DeployStatus |
Integer |
Status of the task; 1 indicates successful creation; 0 indicates that there is a task being updated currently, and no new update task has been created; the returned value DeployRecordId is the task id being updated. |
| UpdateSyncProgress |
Array of UpdateSyncProgress |
Task Progress Details.
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 One-Click Update Of Old Certificate Resource
One-click update of old certificate resources
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCertificateInstance
<Common request parameters>
{
"CertificateId": "Th**jj",
"OldCertificateId": "gej**kkk",
"ResourceTypes": [
"clb"
],
"Regions": [
"ap-guangzhou"
],
"ResourceTypesRegions": [
{
"ResourceType": "clb",
"Regions": [
"ap-guangzhou"
]
}
]
}
Output Example
{
"Response": {
"DeployRecordId": 1763489,
"DeployStatus": 0,
"UpdateSyncProgress": [
{
"ResourceType": "clb",
"UpdateSyncProgressRegions": [
{
"Region": "ap-guangzhou",
"TotalCount": 0,
"OffsetCount": 0,
"Status": 0
}
],
"Status": 0
}
],
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}
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 |
| FailedOperation |
Operation failed. |
| FailedOperation.AuthError |
You do not have permission to perform this operation. |
| FailedOperation.CertificateDeployHasPendingRecord |
There is a running certificate deployment task. Please try again after the deployment is complete. |
| FailedOperation.CertificateDeployInstanceEmpty |
There is no instance for the selected cloud resource. Updating failed. Please try again after checking it. |
| FailedOperation.CertificateExists |
The certificate already exists. |
| FailedOperation.CertificateHostDeployCanNotAllow |
The current certificate is not allowed to use the one-click update function. |
| FailedOperation.CertificateHostResourceInnerInterrupt |
Unable to use the deployment feature because the login account is an internal account with too many instance resources. Please contact us to handle it. |
| FailedOperation.CertificateHostResourceInstanceHugeLimit |
There are too many instances under the current account. Loading cannot be performed properly. Please switch the loading mode. After switching, click "Refresh List" and wait for a period of time. Then, all the instances can be loaded. |
| FailedOperation.CertificateHostResourceTypeInvalid |
The cloud resource type is invalid. |
| 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.CertificateNotAvailable |
The certificate is not available. Please check and try again. |
| FailedOperation.CertificateNotDeployInstance |
The certificate is not allowed to be deployed under the instance list. |
| 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.InvalidParam |
Incorrect parameters. |
| FailedOperation.NoProjectPermission |
You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth |
You have not completed the identity verification. |
| FailedOperation.RoleNotFoundAuthorization |
The role does not exist. Please authorize the role first. |
| InternalError |
Internal error. |
| InvalidParameter.WithDetailReason |
The parameter is incorrect. |
| InvalidParameterValue.IntermediateCertNotSame |
Intermediate certificate inconsistent. |
| LimitExceeded.RateLimitExceeded |
The API rate limit is reached. |