UpgradeInstanceVersion

最后更新时间：2025-10-28 22:21:46

UpgradeInstanceVersion

最后更新时间： 2025-10-28 22:21:46

1. API Description

Domain name for API request: redis.intl.tencentcloudapi.com.

This API is used to upgrade the current instance to a later version or upgrade the current standard architecture to a cluster architecture.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: UpgradeInstanceVersion.
Version	Yes	String	Common Params. The value used for this API: 2018-04-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
TargetInstanceType	Yes	String	Target instance type after the change, which is the same as the `TypeId` of the CreateInstances API. - For Redis 4.0 or later, a standard architecture instance can be upgraded to a cluster architecture instance on the same version; for example, you can upgrade from Redis 4.0 Standard Architecture to Redis 4.0 Cluster Architecture. - Cross-version architecture upgrade is not supported; for example, you cannot upgrade from Redis 4.0 Standard Architecture to Redis 5.0 Cluster Architecture. - The architecture of Redis 2.8 cannot be upgraded. - Cluster architecture cannot be downgraded to standard architecture.
SwitchOption	Yes	Integer	Switch time. Valid values: - `1`: Switch in the maintenance time. - `2` (default value): Switch now.
InstanceId	Yes	String	ID of the specified instance, such as `crs-xjhsdj****`. Log in to the Redis console, and copy it in the instance list.

3. Output Parameters

Parameter Name	Type	Description
DealId	String	Order ID
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Sample

This example shows you how to upgrade the current instance to Redis 4.0 cluster architecture.

Input Example

https://redis.intl.tencentcloudapi.com/?Action=UpgradeInstanceVersion
&InstanceId=crs-5qlr****
&SwitchOption=2
&TargetInstanceType=7
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.SystemError	Internal system error, which is irrelevant to the business.
FailedOperation.Unknown	Invalid data is entered for weekday.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList	The user is not in the allowlist.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud