AddShardingNode - Add data shards to Tair cluster instance - Tair (Redis® OSS-Compatible)

Operation description

Available only for cluster instances that use cloud disks.

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:AddShardingNode

create

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
ShardCount	integer	No	The number of data shards to add. Default: 1. Note Supports 2 to 256 data shards per instance, up to 64 per request.	2
AutoPay	boolean	No	Enables automatic payment. Valid values: true: Enables automatic payment. Ensure sufficient account balance. false: Disables automatic payment. Pay manually before expiration (Instance renewal). Note Default: true.	false
CouponNo	string	No	The coupon ID.	youhuiquan_promotion_option_id_for_blank
BusinessInfo	string	No	Additional business information.	000000000
SourceBiz	string	No	Internal use only.	SDK
ForceTrans	boolean	No	Whether to force the configuration change. Valid values: false (default): Checks the minor version before the change. Returns an error if outdated. Update the minor version and retry. true: Skips the version check and forces the configuration change.	false
VSwitchId	string	No	The vSwitch ID for new shards. Must be in the same VPC. Defaults to the original vSwitch.	vsw-bp1e7clcw529l773d****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B79C1A90-495B-4E99-A2AA-A4DB13B8****
OrderId	integer	The order ID.	20741011111111
NodeIds	array	The data shard IDs.
	string	The data shard ID.	r-8vb0i6z4npbxrf****-db-4

Examples

Success response

JSON format

{
  "RequestId": "B79C1A90-495B-4E99-A2AA-A4DB13B8****",
  "OrderId": 20741011111111,
  "NodeIds": [
    "r-8vb0i6z4npbxrf****-db-4"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.