升级TDSQL独享集群实例

最近更新时间:2024-03-12 01:25:10

我的收藏

1. 接口描述

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

本接口(UpgradeDedicatedDCDBInstance)用于升级TDSQL独享集群实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeDedicatedDCDBInstance。
Version String 公共参数,本接口取值:2018-04-11。
Region String 公共参数,详见产品支持的 地域列表
UpgradeType String 升级类型,取值为ADD,SPLIT和EXPAND。ADD-添加分片;SPLIT-切分某个分片;EXPAND-垂直扩容某个分片
示例值:EXPAND
InstanceId String 实例ID,形如 dcdbt-mlfjm74h
示例值:dcdbt-mlfjm74h
AddShardConfig AddShardConfig 当UpgradeType取值为ADD时,添加分片的配置参数
ExpandShardConfig ExpandShardConfig 当UpgradeType取值为EXPAND时,垂直扩容分片的配置参数
SplitShardConfig SplitShardConfig 当UpgradeType取值为SPLIT时,切分分片的配置参数
SwitchAutoRetry Integer 错过切换时间窗口时,是否自动重试一次,0-否,1-是
示例值:1
SwitchStartTime String 切换时间窗口开始时间
示例值:2020-12-01 00:30:00
SwitchEndTime String 切换时间窗口结束时间
示例值:2020-12-01 00:45:00

3. 输出参数

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

4. 示例

示例1 升级TDSQL独享集群实例

升级TDSQL独享集群实例

输入示例

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

{
    "UpgradeType": "EXPAND",
    "InstanceId": "tdsqlshard-jv8z8fhl",
    "ExpandShardConfig": {
        "ShardInstanceIds": [
            "shard-xxx1",
            "shard-xxx2"
        ],
        "ShardMemory": 2,
        "ShardStorage": 20
    }
}

输出示例

{
    "Response": {
        "RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6",
        "FlowId": 1122
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.FenceError 查询独享集群信息失败。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 未找到请求的实例。
InvalidParameterValue.IllegalExclusterID 找不到数据库实例所属的独享集群。
ResourceUnavailable.ExclusterStatusAbnormal 独享集群状态异常。
ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。
UnsupportedOperation.InvalidOperation 不支持的无效操作。