tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Instance APIsUpgradeInstance
UpgradeInstance
Last updated: 2024-12-04 11:19:03
UpgradeInstance
Last updated: 2024-12-04 11:19:03

1. API Description

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

This API is used to change the configuration specifications of 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 Params. The value used for this API: UpgradeInstance.
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.
InstanceId Yes String The ID of instance to be modified.
MemSize Yes Integer New memory size of an instance shard.
  • Unit: MB.
  • You can only modify one of the three parameters at a time: MemSize, RedisShardNum, and RedisReplicasNum. To modify one of them, you need to enter the other two, which are consistent with the original configuration specifications of the instance.
  • In case of capacity reduction, the new specification must be at least 1.3 times the used capacity; otherwise, the operation will fail.
RedisShardNum No Integer New number of instance shards.
  • This parameter is not required for standard architecture instances, but for cluster architecture instances.
  • For cluster architecture, you can only modify one of the three parameters at a time: MemSize, RedisShardNum, and RedisReplicasNum. To modify one of them, you need to enter the other two, which are consistent with the original configuration specifications of the instance.
RedisReplicasNum No Integer New replica quantity.
  • You can only modify one of the three parameters at a time: MemSize, RedisShardNum, and RedisReplicasNum. To modify one of them, you need to enter the other two, which are consistent with the original configuration specifications of the instance.
To modify the number of replicas in a multi-AZ instance, NodeSet must be passed in.
NodeSet.N No Array of RedisNodeInfo Node information set when you add a replica for multi-AZ instances, including the ID and AZ information of the replica. This parameter is not required for non-multi-AZ instances.

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 Changing Specifications

This example shows you how to modify the instance memory configuration.

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeInstance
<Common request parameters>

{
    "InstanceId": "crs-5qlr****",
    "MemSize": "4096"
}

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.PayFailed Payment failed.
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
FailedOperation.Unknown Invalid data is entered for weekday.
InvalidParameter.InvalidParameter Invalid service parameter.
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 doesn’t exist.
LimitExceeded The quota limit has been reached.
LimitExceeded.InvalidMemSize The requested capacity is out of the purchasable specification range (memSize should be an integer multiple of 1,024 in MB).
ResourceInsufficient The resource is insufficient.
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.
ResourceUnavailable.SaleOut Resources of the specified type in the region are sold out.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support