1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(UpgradeDBInstanceKernelVersion)用于升级数据库实例内核版本。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpgradeDBInstanceKernelVersion。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同 示例值:cmgo-p8vnipr5 |
| InMaintenance | 否 | Integer | 是否维护时间内升级。0-否,1-是 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Integer | 异步流程任务ID 示例值:1367 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 升级实例当前内核版本号
当新版本内核被推出时,可以通过升级内核版本到最新版本
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDBInstanceKernelVersion
<公共请求参数>
{
"InstanceId": "cmgo-p8vnipr5"
}
输出示例
{
"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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CheckAppIdFailed | appId校验失败。 |
| InvalidParameter.PermissionDenied | 当前子账号无权执行该操作。 |
| InvalidParameterValue.IllegalInstanceStatus | 非法的实例状态。 |
| InvalidParameterValue.LockFailed | 实例锁定失败。 |
| InvalidParameterValue.StatusAbnormal | 实例处于不允许操作的状态。 |