1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
将当前实例升级到更高版本,或者将当前标准架构升级至集群架构。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpgradeInstanceVersion。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TargetInstanceType | 是 | String | 目标实例类型,同 CreateInstances 的TypeId,即实例要变更的目标类型。 - Redis 4.0 及以上的版本,支持相同版本的实例从标准架构升级至集群架构,例如,支持 Redis 4.0 标准架构升级至 Redis 4.0 集群架构。 - 不支持跨版本架构升级,例如,Redis 4.0 标准架构升级至 Redis 5.0 集群架构。 - 不支持 Redis 2.8 版本升级架构。 - 不支持从集群架构降级至标准架构。 示例值:6 |
SwitchOption | 是 | Integer | 切换时间。 - 1:维护时间窗切换。 - 2:立即切换。 示例值:2 |
InstanceId | 是 | String | 指定实例 ID。例如:crs-xjhsdj****,请登录Redis控制台在实例列表复制实例 ID。 示例值:crs-5qlrlhux |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealId | String | 订单ID 示例值:6954227 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
升级当前实例至Redis 4.0 集群架构
输入示例
https://redis.tencentcloudapi.com/?Action=UpgradeInstanceVersion
&InstanceId=crs-5qlr****
&SwitchOption=2
&TargetInstanceType=7
&<公共请求参数>
输出示例
{
"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。
- 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.SystemError | 内部系统错误,和业务无关。 |
FailedOperation.Unknown | weekday输入无效数据。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |
UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
UnauthorizedOperation.UserNotInWhiteList | 用户不在白名单中。 |