DeleteShardingNode-阿里云帮助中心

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 ID of the instance.	r-bp1zxszhcgatnx****
NodeId `deprecated`	string	No	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	No	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
EffectiveTime	string	No	The time when you want to delete the proxy nodes for instance in the proxy mode. Valid values: 0 or Immediately (default): immediately delete the proxy nodes. 1 or MaintainTime: delete the proxy nodes during the maintenance window. Note You can call the ModifyInstanceMaintainTime operation to modify the maintenance window of an instance.	Immediately

Response elements

Element	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

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.