文档中心 云数据库 MongoDB API 文档 实例相关接口 升级云数据库实例(包年包月)

升级云数据库实例(包年包月)

最近更新时间:2019-07-24 15:27:47

1. 接口描述

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

本接口(UpgradeDBInstance)用于升级包年包月的MongoDB云数据库实例,可以扩容内存、存储以及Oplog

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mongodb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeDBInstance
Version String 公共参数,本接口取值:2018-04-08
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
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=UpgradeDBInstance
&Memory=4
&Volume=250
&InstanceId=cmgo-f555zzzz
&OplogSize=26
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "be8f4a30-ea2e-4623-8b6b-0ccce04cd9f7",
    "DealId": "19297475"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误