Updates the proxy node of a cluster instance to the latest version.
Operation description
The procedure and impacts for updating the minor version of an instance varies based on the instance architecture. For more information, see Update the minor version of an instance.
-
Before you call this operation, you can call the DescribeEngineVersion operation to query the current minor version of the proxy node.
-
The connection to the instance is interrupted during the update. We recommend that perform an update during off-peak hours. Make sure your application can reconnect to the instance after the update. For more information, see Minor version update.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| kvstore:UpgradeProxy | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The instance ID. | r-bp1vgja77wl7pb**** |
| ProxyInstanceIds | string | No | The IDs of the proxy nodes that you want to update. Separate multiple IDs with commas (,). This parameter is valid only for Redis Open-Source Edition classic instances. | r-bp1vgja77wl7pb****-proxy-0 |
| SwitchTimeMode | integer | Yes | The time to execute the specification change. Valid values:
Note
You can call the ModifyInstanceMaintainTime operation to modify the maintenance window of an instance.
| Immediately |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "B830CDBB-91D9-5571-B6F4-35C76266****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-11-03 | Add Operation | View Change Details |