云数据库 MongoDB 升级数据库版本

1. 接口描述

接口请求域名： mongodb.tencentcloudapi.com 。

本接口（UpgradeDbInstanceVersion）用于升级数据库版本。
说明：支持3.6及以上版本升级，仅支持从低版本向高版本逐级升级，不支持跨版本升级或版本降级。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpgradeDbInstanceVersion。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。示例值：cmgo-p8vnipr5
MongoVersion	是	String	新升级的数据库版本。当前支持版本如下所示，支持旧版本向高版本升级，不支持跨版本升级。 - MONGO_40_WT：4.0 版本。 - MONGO_42_WT：4.2 版本。 - MONGO_44_WT：4.4 版本 - MONGO_50_WT：5.0 版本 - MONGO_60_WT：6.0 版本。 - MONGO_70_WT：7.0 版本。 - MONGO_80_WT：8.0 版本。示例值：MONGO_42_WT
InMaintenance	否	Integer	指定升级操作是否在维护时间内进行。 - 0：立即升级。 - 1：维护时间窗升级。示例值：0

3. 输出参数

参数名称	类型	描述
FlowId	Integer	异步流程任务ID 示例值：1367
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 升级3.6版本实例到4.0版本

用于MongoDB数据库3.6版本升级到4.0版本

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDbInstanceVersion
<公共请求参数>

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

输出示例

{
    "Response": {
        "RequestId": "2efcf780-9970-11ec-8975-6bc44e3bfad7",
        "FlowId": 19677
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBOperateError	内部数据存储异常。
InvalidParameter.PermissionDenied	当前子账号无权执行该操作。

升级数据库版本

本页目录：