1. API Description
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to upgrade the kernel version of the database instance.
A maximum of 20 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: UpgradeDBInstanceKernelVersion. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-07-25. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId |
Yes |
String |
List of instance IDs, which are in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page. |
| InMaintenance |
No |
Integer |
Whether to perform the upgrade during the maintenance period. 0 - no; 1 - yes. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| FlowId |
Integer |
Asynchronous process task ID. |
| 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 Upgrading the Current Kernel Version Number of the Instance
When a new kernel version is launched, you can upgrade the kernel to the latest version.
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDBInstanceKernelVersion
<Common request parameters>
{
"InstanceId": "cmgo-p8vnipr5"
}
Output Example
{
"Response": {
"RequestId": "2efcf780-9970-11ec-8975-6bc44e3bfad7",
"FlowId": 19677
}
}
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 |
| InternalError.CheckAppIdFailed |
appId verification failed. |
| InvalidParameter.PermissionDenied |
The current sub-account has no permission to perform this operation. |
| InvalidParameterValue.IllegalInstanceStatus |
Invalid instance status |
| InvalidParameterValue.LockFailed |
Instance lock failed. |
| InvalidParameterValue.StatusAbnormal |
The instance is in a status where operations are not allowed. |