帮你快速理解、总结文档立即下载
文档中心>API 中心>TDSQL MySQL版>分布式数据库>升级分布式数据库

升级分布式数据库

最近更新时间：2026-08-26 01:33:27
我的收藏

本页目录：

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：UpgradeDCDBInstance。
Version 是 String 公共参数，本接口取值：2018-04-11。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String

待升级的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。


示例值：dcdbt-fdpjf5zh
UpgradeType 是 String

升级类型，取值范围:

  • ADD: 新增分片
  • EXPAND: 升级实例中的已有分片
  • SPLIT: 将已有分片中的数据切分到新增分片上

    • 示例值：ADD
    AddShardConfig 否 AddShardConfig

    新增分片配置，当UpgradeType为ADD时生效。
    ExpandShardConfig 否 ExpandShardConfig

    扩容分片配置，当UpgradeType为EXPAND时生效。
    SplitShardConfig 否 SplitShardConfig

    切分分片配置，当UpgradeType为SPLIT时生效。
    AutoVoucher 否 Boolean

    是否自动使用代金券进行支付，默认不使用。


    示例值：false
    VoucherIds.N 否 Array of String

    代金券ID列表，目前仅支持指定一张代金券。


    示例值：["ZRPCQJGMYSYV73IYOTFJD8"]
    Zones.N 否 Array of String

    变更部署时指定的新可用区列表，第1个为主可用区，其余为从可用区


    示例值：["ap-guangzhou-3", "ap-guangzhou-4"]
    SwitchStartTime 否 String

    切换开始时间，格式如: "2019-12-12 07:00:00"。开始时间必须在当前时间一个小时以后，3天以内。


    示例值：2019-12-12 07:00:00
    SwitchEndTime 否 String

    切换结束时间, 格式如: "2019-12-12 07:15:00"，结束时间必须大于开始时间。


    示例值：2019-12-12 07:15:00
    SwitchAutoRetry 否 Integer

    是否自动重试。 0：不自动重试 1：自动重试


    示例值：1
    SwitchInterval 否 Integer

    多个分片同时发起扩容，并发切换中的切换时间间隔，即当前分片切换开始时间和下一个分片的切换开始时间间隔，不传默认为1。

    取值范围：[1, 180]

    单位：秒


    示例值：1

    3. 输出参数

    参数名称 类型 描述
    DealName String

    长订单号。可以据此调用 DescribeOrders
    查询订单详细信息，或在支付失败时调用用户账号相关接口进行支付。


    示例值：20180103110035
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 分布式垂直扩容示例

    输入示例

    POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDCDBInstance
<公共请求参数>

{
    "InstanceId": "tdsqlshard-8q7j1jpih1",
    "UpgradeType": "EXPAND",
    "ExpandShardConfig": {
        "ShardInstanceIds": [
            "shard-ezn4l0i8mf"
        ],
        "ShardMemory": 2,
        "ShardStorage": 20,
        "ShardNodeCount": 2
    },
    "SwitchStartTime": "2026-08-20 18:00:00",
    "SwitchEndTime": "2026-08-20 18:15:00",
    "SwitchInterval": 1
}

    输出示例

    {
    "Response": {
        "DealName": "20260820013023408391271",
        "RequestId": "01f590d7-6046-4625-b4ac-b72ed110aeff"
    }
}

    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.PayFailed 支付订单失败。
    InternalError.CamAuthFailed CAM鉴权请求失败。
    InternalError.DbOperationFailed 查询数据库失败。
    InternalError.QueryPriceFailed 查询价格失败。
    InvalidParameter.GenericParameterError 参数合法性校验错误。
    InvalidParameter.InstanceNotFound 未找到请求的实例。
    InvalidParameter.NotSupportedPayMode 该接口不支持此付费类型的实例。
    InvalidParameter.SpecNotFound 找不到对应的售卖规格。
    InvalidParameterValue.SpecIdIllegal 找不到数据库实例对应的规格信息。
    ResourceNotFound.NoInstanceFound 找不到指定的数据库实例。
    ResourceUnavailable.InstanceHasBeenLocked 数据库实例已经被锁定，当前无法操作。
    ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确，当前无法操作。
    UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。
    中国站