文档中心 云数据库 MySQL API 文档 实例相关接口 调整云数据库实例的配置

调整云数据库实例的配置

最近更新时间:2019-09-19 20:01:29

1. 接口描述

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

本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeDBInstance
Version String 公共参数,本接口取值:2017-03-20
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。
Memory Integer 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 获取云数据库可售卖规格 接口获取可升级的内存规格。
Volume Integer 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 获取云数据库可售卖规格 接口获取可升级的硬盘范围。
ProtectMode Integer 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
DeployMode Integer 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
SlaveZone String 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 获取云数据库可售卖规格 接口查询支持的可用区。
EngineVersion String 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
WaitSwitch Integer 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级中过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 切换访问新实例 触发该流程。
BackupZone String 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
InstanceRole String 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。

3. 输出参数

参数名称 类型 描述
DealIds Array of String 订单 ID。
AsyncRequestId String 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 升级云数据库实例

输入示例

https://cdb.tencentcloudapi.com/?Action=UpgradeDBInstance
&InstanceId=cdb-6si6qy6p
&Memory=1000
&Volume=50
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "DealIds": [
      "20171204110077"
    ],
    "AsyncRequestId": "a6040589-3b098df5-b551d9e5-81c6bfdc"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.StatusConflict 任务状态冲突。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.TradeError 交易系统错误。
InvalidParameter 参数错误。