UpgradeInstanceVersion

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-07-02 15:30:48

Download PDF

1. API Description

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

This API is used to upgrade compatible instance version (for example, from Redis 2.8 to 4.0), or upgrade instance architecture (for example, from standard architecture to cluster architecture).

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: UpgradeInstanceVersion.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
TargetInstanceType	Yes	String	The target instance type to which the instance will change. It is the same as the `TypeId` parameter in the CreateInstances API.
SwitchOption	Yes	Integer	Switch mode. Valid values: 1 (switch during the maintenance window), 2 (switch immediately).
InstanceId	Yes	String	Instance ID

3. Output Parameters

Parameter Name	Type	Description
DealId	String	Order ID
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample

Input Example

https://redis.tencentcloudapi.com/?Action=UpgradeInstanceVersion
&InstanceId=crs-5qlrlhux
&SwitchOption=2
&TargetInstanceType=6
&<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.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList	The user is not in the allowlist.

Recent Pages