操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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 - 表示只读实例。
DeviceType String 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
Cpu Integer 升级后的实例cpu核数, 如果不传将根据 Memory 指定的内存值自动填充对应的cpu值。
FastUpgrade Integer 是否极速变配。0-普通升级,1-极速变配。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
MaxDelayTime Integer 延迟阈值。取值范围1~10,默认值为10。
CrossCluster Integer 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
ZoneId String 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。

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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError 后端错误或者流程错误。
FailedOperation.StatusConflict 任务状态冲突。
InternalError.CauthError 鉴权失败。
InternalError.CdbError 系统错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.FtpError 文件传输异常。
InternalError.TradeError 交易系统错误。
InternalError.UndefinedError 未知错误。
InternalError.VpcError 私有网络或子网错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。
目录