1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(UpgradeDBInstanceHour)用于升级按量计费的MongoDB云数据库实例,可以扩容内存、存储以及oplog
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mongodb.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpgradeDBInstanceHour |
Version | 是 | String | 公共参数,本接口取值:2018-04-08 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID,格式如:cmgo-p8vnipr5 |
Memory | 是 | Integer | 升级后的内存大小,单位:GB |
Volume | 是 | Integer | 升级后的硬盘大小,单位:GB |
OplogSize | 否 | Integer | 升级后oplog的大小,单位:GB,默认为磁盘空间的10%,允许设置的最小值为磁盘的10%,最大值为磁盘的90% |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealId | String | 订单ID |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 升级包年包月的云数据库实例
用户需要通过API升级包年包月的云数据库实例
输入示例
https://mongodb.tencentcloudapi.com/?Action=UpgradeDBInstanceHour
&Memory=4
&Volume=250
&InstanceId=cmgo-f555zzz
&OplogSize=25
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"DealId": "20171201160000002670226599824833"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误 |