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.
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 | ID of the instance whose configuration is to be modified. Log in to the TencentDB for Redis® console and copy the instance ID from the instance list. |
| MemSize | Yes | Integer | Refers to the size of memory in each shard after the change. -Unit: MB. -You can only modify one of the parameters MemSize, RedisShardNum, and RedisReplicasNum each time, and cannot include both. When modifying one parameter, you need to manually input the original instance configuration specification for the other two parameters. -When scaling down, the new specifications must be equal to or greater than 1.3 times the used capacity, otherwise execution will fail. |
| RedisShardNum | No | Integer | Specifies the number of shards after the instance specification modification. -Standard architecture does not require this parameter, while cluster architecture is mandatory. -Cluster architecture. Every time, you can only modify one of the parameters RedisShardNum, MemSize, and RedisReplicasNum. You cannot modify them simultaneously. When modifying one parameter, you need to manually input the original instance configuration specification for the other two parameters. |
| RedisReplicasNum | No | Integer | Specifies the number of replicas after the instance specification modification. -Only one of the parameters RedisReplicasNum, MemSize, and RedisShardNum can be modified each time. You cannot include both. When modifying one parameter, the other two parameters require the original instance configuration specification. -When modifying a replica of a multi-AZ instance, you must input NodeSet. |
| 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. |
| SwitchOption | No | Integer | Switch time. - 1: Perform the operation within the maintenance window: Specification upgrade is executed within the set maintenance window. Use the API DescribeMaintenanceWindow to query the time period of the set maintenance window. Replica addition/removal, shard addition/removal, and memory capacity expansion/shrinkage are supported within the maintenance window. Specification upgrade within the maintenance window is being gradually tested and published by region. It is already supported in some regions. For urgent integration in regions that do not support it, submit a ticket to apply for an allowlist. -2: Perform the operation immediately: The operation will be performed immediately, without the need to wait for the maintenance window. Operations will be performed immediately by default for the system. |
| Parameter Name | Type | Description |
|---|---|---|
| DealName | String | Order number. |
| 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. |
This example shows you how to modify the instance memory configuration.
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
}{
"Response": {
"DealName": "20250825297021509398751",
"RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InvalidParameterValue.UnSupportedType | The instance type is not supported. |
| 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. |
| UnsupportedOperation.LowVersion | The instance version is too low. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários