1. 接口描述
接口请求域名: mariadb.tencentcloudapi.com 。
本接口(UpgradeDBInstance)用于扩容云数据库实例。本接口完成下单和支付两个动作,如果发生支付失败的错误,调用用户账户相关接口中的支付订单接口(PayDeals)重新支付即可。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpgradeDBInstance。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 待升级的实例ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。 示例值:tdsql-avw0207d |
Memory | 是 | Integer | 内存大小,单位:GB,可以通过 DescribeDBInstanceSpecs 查询实例规格获得。 示例值:2000 |
Storage | 是 | Integer | 存储空间大小,单位:GB,可以通过 DescribeDBInstanceSpecs 查询实例规格获得不同内存大小对应的磁盘规格下限和上限。 示例值:20000 |
AutoVoucher | 否 | Boolean | 是否自动使用代金券进行支付,默认不使用。 示例值:true |
VoucherIds.N | 否 | Array of String | 代金券ID列表,目前仅支持指定一张代金券。 示例值:[] |
Zones.N | 否 | Array of String | 变更部署时指定的新可用区列表,第1个为主可用区,其余为从可用区 示例值:[] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealName | String | 长订单号。可以据此调用 DescribeOrders 查询订单详细信息,或在支付失败时调用用户账号相关接口进行支付。 示例值:20171103110035 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 扩容云数据库实例
输入示例
https://mariadb.tencentcloudapi.com/?Action=UpgradeDBInstance
&InstanceId=tdsql-avw0207d
&Memory=2000
&Storage=20000
&AutoVoucher=true
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "9b59ee51-0e13-1c2f-dedb-59fabe9d7f4a",
"DealName": "20171103110035"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CreateOrderFailed | 创建订单失败。 |
FailedOperation.PayFailed | 支付订单失败。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InvalidParameter.SpecNotFound | 找不到对应的售卖规格。 |
InvalidParameterValue.SpecIdIllegal | 找不到数据库实例对应的规格信息。 |
ResourceNotFound.NoInstanceFound | 找不到指定的数据库实例。 |
ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确,当前无法操作。 |
UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |