1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
本接口(UpgradeDBInstanceEngineVersion)用于升级云数据库实例版本，实例类型支持主实例、灾备实例和只读实例等。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpgradeDBInstanceEngineVersion。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同，可使用 查询实例列表 接口获取，其值为输出参数中字段 InstanceId 的值。 示例值：cdb-8qrg9t04 |
| EngineVersion | 是 | String | 主实例数据库引擎版本，支持值包括：5.6 和 5.7。 示例值：5.7 |
| WaitSwitch | 否 | Integer | 切换访问新实例的方式，默认为 0。支持值包括：0 - 立刻切换，1 - 时间窗切换；当该值为 1 时，升级过程中，切换访问新实例的流程将会在时间窗内进行，或者用户主动调用接口 切换访问新实例 触发该流程。 示例值：1 |
| UpgradeSubversion | 否 | Integer | 是否是内核子版本升级，支持的值：1 - 升级内核子版本；0 - 升级数据库引擎版本。 示例值：20201231 |
| MaxDelayTime | 否 | Integer | 延迟阈值。取值范围1~10 示例值：1 |
| IgnoreErrKeyword | 否 | Integer | 5.7升级8.0是否忽略关键字错误，取值范围[0,1]，1表示忽略，0表示不忽略 示例值：1 |
| ParamList.N | 否 | Array of UpgradeEngineVersionParams | 版本升级支持指定参数 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AsyncRequestId | String | 异步任务 ID，可使用 查询异步任务的执行结果 获取其执行情况。 示例值：d2baf2fb-cbae62df-7dd0d736-9cbd3e31 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 升级云数据库实例版本
升级云数据库实例版本
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDBInstanceEngineVersion
<公共请求参数>
{
"InstanceId": "cdb-8qrg9t04",
"EngineVersion": "5.7"
}输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestId": "d2baf2fb-cbae62df-7dd0d736-9cbd3e31"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.StatusConflict | 任务状态冲突。 |
| InternalError.CdbError | 系统错误。 |
| InternalError.DatabaseAccessError | 数据库内部错误。 |
| InternalError.FtpError | 文件传输异常。 |
| InternalError.TradeError | 交易系统错误。 |
| InternalError.UndefinedError | 未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 实例不存在。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ActionNotSupport | 不支持的操作。 |
| OperationDenied.UserHasNoStrategy | 用户没有该策略权限。 |
