All Products
Search

This Product

    Tair:AddShardingNode

    Document Center

    Tair:AddShardingNode

    Last Updated:Feb 20, 2024

    Adds one or more data shards to an ApsaraDB for Redis cluster instance.

    Operation description

    This operation is available only for cluster instances that use cloud disks.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    kvstore:AddShardingNodeWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    ShardCountintegerNo

    The number of data shards that you want to add. Default value: 1.

    Note The instance can contain 2 to 256 data shards. You can add up to 64 data shards at a time. Make sure that the number of shards does not exceed this limit.
    		2
    AutoPaybooleanNo

    Specifies whether to enable automatic payment. Valid values:

    • true: enables automatic payment. Make sure that you have sufficient balance within your account.
    • false: disables automatic payment. In this case, you must manually renew the instance in the console before the instance expires. For more information, see Renewal .
    Note The default value is true.
    		false
    CouponNostringNo

    The ID of the coupon.

    		youhuiquan_promotion_option_id_for_blank
    BusinessInfostringNo

    The business information. This is an additional parameter.

    		000000000
    SourceBizstringNo

    The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.

    		SDK
    ForceTransbooleanNo

    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
    VSwitchIdstringNo

    The vSwitch ID. You can specify a different vSwitch within the same virtual private cloud (VPC). In this case, the new data shards are created in the specified vSwitch. If you do not specify this parameter, the new data shards are created in the original vSwitch.

    		vsw-bp1e7clcw529l773d****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		B79C1A90-495B-4E99-A2AA-A4DB13B8****
    OrderIdlong

    The ID of the order.

    		20741011111111
    NodeIdsarray

    The IDs of the data shards.

    string

    The ID of the data shard.

    		r-8vb0i6z4npbxrf****-db-4

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-08-30The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: VSwitchId
    2023-07-04The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ForceTrans
    2023-03-02The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2022-09-16The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2022-09-16The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.