tencent cloud

APIs

UpgradeDbInstanceVersion

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-19 16:02:36

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to upgrade database version.
Description: Upgrade to version 3.6 and above is supported. Only upgrading from a lower version to a higher version step by step is allowed. Cross-version upgrade or version downgrade is not supported.

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.

2. Input Parameters

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 The newly upgraded database version. Currently supported versions are as follows. Upgrade from an earlier version to a high version is supported. Cross-version upgrade is not supported.
- MONGO_40_WT: Version 4.0.
- MONGO_42_WT: Version 4.2.
- MONGO_44_WT: Version 4.4.
- MONGO_50_WT: Version 5.0.
- MONGO_60_WT: Version 6.0.
-MONGO_70_WT: Version 7.0.
- MONGO_80_WT: Version 8.0.
InMaintenance No Integer Specify whether to perform the upgrade during the maintenance period.
-0: Upgrade now.
- 1: Upgrade during the maintenance window.

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 an Instance from 3.6 to 4.0

This example shows you how to upgrade a TencentDB for MongoDB instance from 3.6 to 4.0.

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDbInstanceVersion
<Common request parameters>

{
    "InstanceId": "cmgo-p8vn****",
    "MongoVersion": "MONGO_42_WT"
}

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 Internal error
InternalError.DBOperateError An internal data storage exception occurs.
InvalidParameter.PermissionDenied The current sub-account has no permission to perform this operation.

Ajuda e Suporte

Esta página foi útil?

comentários