Enables or disables the proxy mode for an ApsaraDB for Redis cluster instance in a dedicated cluster.
Operation description
For more information about the proxy mode, see Features of proxy nodes. Before you call this operation, make sure that the following requirements are met:
- Your ApsaraDB for Redis instance is created by using a dedicated cluster. For more information, see What is ApsaraDB MyBase?
- The instance uses the cluster architecture. For more information about the cluster architecture, see Cluster master-replica instances.
Note
Before you call the SwitchInstanceProxy operation, you must call the DescribeDedicatedClusterInstanceList operation and view the value of the ProxyCount response parameter to check whether the proxy mode is enabled. A value of 0 indicates that the proxy mode is disabled. A value that is greater than 0 indicates that the proxy mode is enabled.
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:
- The required resource types are displayed in bold characters.
- 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:SwitchInstanceProxy | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance. | r-bp1zxszhcgatnx**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-20 | API Description Update | View Change Details |