升级实例

最近更新时间:2024-03-12 01:47:16

我的收藏

1. 接口描述

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

本接口(UpgradeDBInstance)用于升级实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeDBInstance。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,形如mssql-j8kv137v
示例值:mssql-j8kv137v
Memory Integer 实例升级后内存大小,单位GB,其值不能小于当前实例内存大小
示例值:4
Storage Integer 实例升级后磁盘大小,单位GB,其值不能小于当前实例磁盘大小
示例值:400
AutoVoucher Integer 是否自动使用代金券,0 - 不使用;1 - 默认使用。取值默认为0
示例值:0
VoucherIds.N Array of String 代金券ID,目前单个订单只能使用一张代金券
示例值:0
Cpu Integer 实例升级后的CPU核心数
示例值:1
DBVersion String 升级sqlserver的版本,目前支持:2008R2(SQL Server 2008 Enterprise),2012SP3(SQL Server 2012 Enterprise)版本等。每个地域支持售卖的版本不同,可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息,版本不支持降级,不填则不修改版本
示例值:2008R2
HAType String 升级sqlserver的高可用架构,从镜像容灾升级到always on集群容灾,仅支持2017及以上版本且支持always on高可用的实例,不支持降级到镜像方式容灾,CLUSTER-升级为always on容灾,不填则不修改高可用架构
示例值:CLUSTER
MultiZones String 修改实例是否为跨可用区容灾,SameZones-修改为同可用区 MultiZones-修改为跨可用区
示例值:MultiZones
WaitSwitch Integer 执行变配的方式,默认为 1。支持值包括:0 - 立刻执行,1 - 维护时间窗执行
示例值:1

3. 输出参数

参数名称 类型 描述
DealName String 订单名称
示例值:201806261980
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 升级实例

输入示例

https://sqlserver.tencentcloudapi.com/?Action=UpgradeDBInstance
&InstanceId=mssql-j8kv137v
&Memory=4
&Storage=400
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "DealName": "201806261980"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CreateOrderFailed 创建订单失败。
FailedOperation.DBError 数据库错误。
FailedOperation.QueryPriceFailed 计费相关错误,查询价格失败。
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
InvalidParameter.PayOrderFailed 支付订单失败。
InvalidParameterValue.IllegalSpec 实例规格信息错误。
InvalidParameterValue.ParameterTypeError 参数类型错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。