DeleteShardingNode -

Removes one or more data shards from an ApsaraDB for Redis cluster instance.

Operation description

You can also remove data shards from an instance in the ApsaraDB for Redis console. For more information, see Adjust the number of shards for an ApsaraDB for Redis instance with cloud disks.
Before you call this operation, make sure that the instance meets the following requirements:

The instance is a persistent memory-optimized instance in the cluster architecture. For more information about persistent memory-optimized instances, see Persistent memory-optimized instances.
The instance has more than one data shard.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:DeleteShardingNode	delete	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
NodeId`deprecated`	string	Yes	The ID of the data shard that you want to remove. You can specify multiple IDs at a time. Separate multiple IDs with commas (,). Note If you specify both the NodeId and ShardCount parameters, the system prioritizes the NodeId parameter.	r-bp1zxszhcgatnx**-db-0,r-bp1zxszhcgatnx**-db-1
ShardCount	integer	Yes	The number of data shards that you want to remove. Shard removal starts from the end of the shard list. Note For example, the instance has the following data shards: db-0, db-1, db-2, db-3, and db-4. In this case, if you set this parameter to 2, db-3 and db-4 are removed.	1
ForceTrans	boolean	No	Specifies whether to enable forced transmission during a configuration change. Valid values: false (default): Before the configuration change, the system checks the minor version of the instance. If the minor version of the instance is outdated, an error is reported. You must update the minor version of the instance and try again. true: The system skips the version check and directly performs the configuration change.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	5D622714-AEDD-4609-9167-F5DDD3D1****
OrderId	string	The ID of the order. On the Orders page in the Billing Management console, you can obtain the details of the order based on the order ID.	22179******0904

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-04	The request parameters of the API has changed	View Change Details
2022-07-14	The internal configuration of the API is changed, but the call is not affected	View Change Details