升级MongoDB实例的数据库版本。
接口说明
调用本接口时，要求实例状态为运行中。
说明
实例的存储引擎对数据库版本的选择有约束性，详情请参见 MongoDB 数据库版本升级说明，您也可以调用 DescribeAvailableEngineVersion 接口查询实例可升级的版本。
升级数据库版本后不支持降级数据库版本。
升级过程中会自动对实例进行 2-3 次重启，请确保在业务低峰执行。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:UpgradeDBInstanceEngineVersion | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 | dds-bpxxxxxxxx |
| EngineVersion | string | 是 | 升级的目标数据库版本，取值：3.4、4.0、4.2。 说明
升级的目标数据库版本必须大于实例当前的数据库版本。
| 4.0 |
| SwitchMode | integer | 否 | 实例版本升级模式。取值：
| 1 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "C4907B00-A208-4E0C-A636-AA85140E406C"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | EngineVersion.ERROR | Target engineVersion must be greater than the current one. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-01-09 | OpenAPI 错误码发生变更 | 查看变更详情 |