Use DeleteShardingNode to remove data shards from a cluster instance - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DeleteShardingNode

delete

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
NodeId `deprecated`	string	No	The IDs of the data shard nodes to delete. Separate multiple node IDs with commas (,). Note If both the NodeId and ShardCount parameters are specified, the NodeId parameter takes precedence.	r-bp1zxszhcgatnx**-db-0,r-bp1zxszhcgatnx**-db-1
ShardCount	integer	No	The number of shards to delete. The system counts from the end and deletes the specified number of shard nodes. Note For example, if an instance has five shard nodes named db-0, db-1, db-2, db-3, and db-4, and you set this parameter to 2, the db-3 and db-4 nodes are deleted.	1
ForceTrans	boolean	No	Specifies whether to enable force transition. Valid values: false (default): Before the Upgrade/Downgrade, the system checks the current minor engine version of the instance. If the minor engine version is too low, an error is reported. You must upgrade the minor engine version and retry. true: Skips the check and directly executes the Upgrade/Downgrade operation.	false
EffectiveTime	string	No	The time when the proxy deletion takes effect if proxy nodes are deleted while deleting shards from a cluster instance in proxy mode. Valid values: 0 or Immediately: The operation takes effect immediately. This is the default value. 1 or MaintainTime: The operation takes effect during the maintenance window. Note You can call the ModifyInstanceMaintainTime operation to modify the maintenance window of the instance. Valid values: 0 : Takes effect immediately. 1 : Takes effect during the maintenance window. Immediately : Takes effect immediately. MaintainTime : Takes effect during the maintenance window.	Immediately

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5D622714-AEDD-4609-9167-F5DDD3D1****
OrderId	string	The order ID. You can use this order ID to obtain the order details in the Orders section of the User Center.	22179******0904

Examples

Success response

JSON format

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "OrderId": "22179******0904"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.