产品动态
公告
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to upgrade the database kernel across versions. Currently, it is only supported to upgrade from version 3.6 to 4.0, 4.0 to 4.2, 4.2 to 4.4, and 4.4 to 5.0.
A maximum of 20 requests can be initiated per second for this API.
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: UpgradeDbInstanceVersion. |
| 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. |
| MongoVersion | Yes | String | Newly upgraded database version. Currently, it only supports MONGO_40_WT (version of the MongoDB 4.0 WiredTiger storage engine) and MONGO_42_WT (version of the MongoDB 4.2 WiredTiger storage engine). |
| InMaintenance | No | Integer | Whether to perform the upgrade during the maintenance period. 0 - upgrade now; 1 - upgrade during the maintenance period. |
| 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. |
This example shows you how to upgrade a TencentDB for MongoDB instance from 3.6 to 4.0.
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDbInstanceVersion
<Common request parameters>
{
"InstanceId": "cmgo-p8vnipr5",
"MongoVersion": "MONGO_42_WT"
}{
"Response": {
"RequestId": "2efcf780-9970-11ec-8975-6bc44e3bfad7",
"FlowId": 19677
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.DBOperateError | An internal data storage exception occurs. |
| InvalidParameter.PermissionDenied | The current sub-account has no permission to perform this operation. |
文档反馈