UpgradeInstance

最后更新时间:2021-11-18 10:45:26

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.

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: 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. This parameter cannot be passed in at the same time as RedisShardNum/RedisReplicasNum.
RedisShardNum No Integer Shard quantity. This parameter is not required by standard architecture instances and cannot be passed in at the same time as RedisReplicasNum/MemSize.
RedisReplicasNum No Integer Replica quantity. This parameter cannot be passed in at the same time as RedisShardNum/MemSize. To modify the number of replicas in a multi-AZ instance, NodeSet must be passed in.
NodeSet.N No Array of RedisNodeInfo The information of the replica to be added to a multi-AZ instance, such as replica availability zone and replica type (NodeType should be 1). This parameter is required only when multi-AZ instances add replicas.

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 request

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

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
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
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.
InvalidParameterValue.SpecNotExist The instance specification does not exist.
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.
ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.