升级分布式数据库

最近更新时间:2018-09-28 14:59:40

1. 接口描述

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

本接口(UpgradeDCDBInstance)用于升级分布式数据库实例。本接口完成下单和支付两个动作,如果发生支付失败的错误,调用用户账户相关接口中的支付订单接口(PayDeals)重新支付即可。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeDCDBInstance
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
InstanceId String 待升级的实例ID。形如:dcdbt-ow728lmc,可以通过 DescribeDCDBInstances 查询实例详情获得。
UpgradeType String 升级类型,取值范围:
  • ADD: 新增分片

  • EXPAND: 升级实例中的已有分片

  • SPLIT: 将已有分片中的数据切分到新增分片上
  • AddShardConfig AddShardConfig 新增分片配置,当UpgradeType为ADD时生效。
    ExpandShardConfig ExpandShardConfig 扩容分片配置,当UpgradeType为EXPAND时生效。
    SplitShardConfig SplitShardConfig 切分分片配置,当UpgradeType为SPLIT时生效。
    AutoVoucher Boolean 是否自动使用代金券进行支付,默认不使用。
    VoucherIds.N Array of String 代金券ID列表,目前仅支持指定一张代金券。

    3. 输出参数

    参数名称 类型 描述
    DealName String 长订单号。可以据此调用 DescribeOrders
    查询订单详细信息,或在支付失败时调用用户账号相关接口进行支付。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 示例

    示例1 升级分布式数据库

    输入示例

    https://dcdb.tencentcloudapi.com/?Action=DescribeUpgradePrice
    &InstanceId=dcdbt-fdpjf5zh
    &UpgradeType=ADD
    &AddShardConfig.ShardCount=2
    &AddShardConfig.ShardMemory=2
    &AddShardConfig.ShardStorage=10
    &AutoVoucher=false
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DealName": "20180103110035",
        "RequestId": "9b59ee51-0e13-1c2f-dedb-59fabe9d7f4a"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.CreateOrderFailed 创建订单失败。
    FailedOperation.PayFailed 支付订单失败。
    InternalError.CamAuthFailed CAM鉴权请求失败。
    InternalError.DbOperationFailed 查询数据库失败。
    InvalidParameter.GenericParameterError 参数合法性校验错误。
    InvalidParameter.SpecNotFound 找不到对应的售卖规格。
    InvalidParameterValue.SpecIdIllegal 找不到数据库实例对应的规格信息。
    ResourceNotFound.NoInstanceFound 找不到指定的数据库实例。
    ResourceUnavailable.InstanceHasBeenLocked 数据库实例已经被锁定,当前无法操作。
    ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
    UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。