Help & DocumentationAPIsTencentDB for RedisInstance APIsUpgradeInstance

UpgradeInstance

Last updated: 2020-04-02 18:00:29

Contents：

1. API Description

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

This API is used to upgrade an instance.

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

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: UpgradeInstance.
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.
InstanceId Yes String Instance ID
MemSize Yes Integer Shard size in MB
RedisShardNum No Integer Number of shards. This parameter can be left blank for Redis 2.8 master-slave edition, CKV master-slave edition, and Redis 2.8 standalone edition
RedisReplicasNum No Integer Number of replicas. This parameter can be left blank for Redis 2.8 master-slave edition, CKV master-slave edition, and Redis 2.8 standalone edition

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 Request Sample

Input Example

https://redis.tencentcloudapi.com/?Action=UpgradeInstance
&InstanceId=crs-5qlrlhux
&MemSize=4096
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.MemSizeNotInRange The requested capacity is out of the purchasable capacity range.
InvalidParameterValue.ReduceCapacityNotAllowed The request capacity is too small. Capacity reduction is not supported.
LimitExceeded.InvalidMemSize The requested capacity is out of the purchasable specification range (memSize should be an integer multiple of 1,024 in MB).
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
ResourceUnavailable.AccountBalanceNotEnough The request order number does not exist.
ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.