ModifyNodeSpecBatch - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.

Operation description

Before you call this operation, ensure that you understand the billing methods and pricing of ApsaraDB for MongoDB.

This operation applies only to ApsaraDB for MongoDB sharded cluster instances.

When you upgrade or downgrade multiple sharded cluster instances in a batch, the target instance types are subject to certain constraints. For example, if you expand storage capacity, the target capacity must be greater than or equal to the current capacity. If the instances have different instance types, the system randomly selects the instance type of one instance and applies its constraints to the entire batch. This may cause the upgrade or downgrade to fail. If you cannot upgrade or downgrade instances in a batch, you can use the ModifyNodeSpec operation to change the configuration of a single sharded cluster instance.

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

dds:ModifyNodeSpecBatch

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	Yes	The ID of the instance for which you want to change configurations.	dds-bp1337621e8f****
NodesInfo	string	Yes	The instance types of the Mongos and shard nodes that you want to change. For more information, see Instance types.	{"Shards":[{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp14ae4572fd**","Storage":20},{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp19f4f92dc5**","Storage":30}]}
ClientToken	string	No	A client token. It is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz****
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true: Automatic payment is enabled. Make sure that your account has a sufficient balance. false: Manual payment is enabled. Log on to the ApsaraDB for MongoDB console. In the upper-right corner, choose Expenses > Expenses and Costs. In the navigation pane on the left, click Order Management. On the Product Orders page, find the target order and pay for it. Default value: true.	true
EffectiveTime	string	No	The effective period of the configuration change. Valid values: Immediately: The change takes effect immediately. MaintainTime: The change takes effect during the maintenance window of the instance. Note You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window of an instance. You can call the DescribeDBInstanceAttribute operation to view the maintenance window of an instance. Default value: Immediately.	Immediately
OrderType	string	No	The type of configuration change. Valid values: UPGRADE: Upgrades the instance configuration. DOWNGRADE: Downgrades the instance configuration. Note This parameter is available only when the billing method of the instance is subscription.	UPGRADE
CouponNo	string	No	Specifies whether to use a coupon. Valid values: default or null (default): A coupon is used. youhuiquan_promotion_option_id_for_blank: A coupon is not used.	default
BusinessInfo	string	No	The business information.	{“ActivityId":"000000000"}
TargetVswitchId	string	No	The ID of the destination virtual switch for a configuration change that involves a zone migration. Important This parameter applies only to instances that use disks. Note This parameter is required only for a configuration change that involves a zone migration.	vsw-xxxxxxxx
TargetHiddenZoneId	string	No	The destination zone of the hidden node for a configuration change that involves a zone migration. Important This parameter applies only to instances that use disks. Important The value of this parameter cannot be the same as the value of the TargetZoneId or TargetSecondaryZoneId parameter. Note This parameter is required only for a configuration change that involves a zone migration.	cn-hangzhou-e
TargetZoneId	string	No	The destination zone of the primary node for a configuration change that involves a zone migration. Important This parameter applies only to instances that use disks. Important The value of this parameter cannot be the same as the value of the TargetSecondaryZoneId or TargetHiddenZoneId parameter. Note This parameter is required only for a configuration change that involves a zone migration.	cn-hangzhou-h
TargetSecondaryZoneId	string	No	The destination zone of the secondary node for a configuration change that involves a zone migration. Important This parameter applies only to instances that use disks. Important The value of this parameter cannot be the same as the value of the TargetZoneId or TargetHiddenZoneId parameter. Note This parameter is required only for a configuration change that involves a zone migration.	cn-hangzhou-j

Response elements

Element	Type	Description	Example
	object
OrderId	string	The order ID.	21012719476****
RequestId	string	The request ID.	0637BC25-6895-5500-871F-1127CA34****

Examples

Success response

JSON format

{
  "OrderId": "21012719476****",
  "RequestId": "0637BC25-6895-5500-871F-1127CA34****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	GadInstanceNotSupport	GAD Instance doesn't support the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.