操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

变更实例配置接口请求域名: redis.tencentcloudapi.com 。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeInstance。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 待变更实例 ID。
MemSize Integer 指实例每个分片内存变更后的大小。
  • 单位 MB。
  • 每次只能修改参数MemSize、RedisShardNum和RedisReplicasNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。
  • 缩容时,缩容后的规格务必要大于等于使用容量的1.3倍,否则将执行失败。
RedisShardNum Integer 指实例变更后的分片数量。
  • 标准架构不需要配置该参数,集群架构为必填参数。
  • 集群架构,每次只能修改参数RedisShardNum、MemSize和RedisReplicasNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。
RedisReplicasNum Integer 指实例变更后的副本数量。
  • 每次只能修改参数RedisReplicasNum、MemSize和RedisShardNum其中的一个,不能同时修改。且修改其中一个参数时,其他两个参数需输入实例原有的配置规格。
  • 多AZ实例修改副本时必须要传入NodeSet。
NodeSet.N Array of RedisNodeInfo 多AZ实例,增加副本时的附带信息,包括副本的可用区和副本的类型(NodeType为1)。非多AZ实例不需要配置该参数。

3. 输出参数

参数名称 类型 描述
DealId String 订单ID。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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

{
    "InstanceId": "crs-5qlr****",
    "MemSize": "4096",
    "RedisShardNum": 5,
    "RedisReplicasNum": 3
}

输出示例

{
    "Response": {
        "DealId": "6954227",
        "RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.Unknown weekday输入无效数据。
InvalidParameter.InvalidParameter 业务参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.MemSizeNotInRange 请求的容量不在售卖容量范围内。
InvalidParameterValue.ReduceCapacityNotAllowed 请求容量偏小,不支持缩容。
InvalidParameterValue.SpecNotExist 实例规格不存在。
LimitExceeded.InvalidMemSize 请求的容量不在售卖规格中(memSize应为1024的整数倍,单位:MB)。
ResourceInsufficient 资源不足。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。
ResourceUnavailable.AccountBalanceNotEnough 请求订单号不存在。
ResourceUnavailable.InstanceStatusAbnormal redis 状态异常,不能执行对应流程。
ResourceUnavailable.InstanceStatusError 实例状态异常,不能执行对应操作。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
目录