All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyNodeSpecBatch

Last Updated:Apr 01, 2024

Changes the configurations of mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.

Operation description

Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before you call this operation.

This operation is applicable only to sharded cluster instances.

When you upgrade or downgrade the configurations of multiple sharded cluster instances in batches, the specifications of the instances are limited. For example, if you want to expand the storage capacity of the instances, the storage capacity of the instances after expansion must be greater than the current capacity. When the specifications of multiple sharded cluster instances are different, limits are defined based on the specifications of a random sharded cluster instance. In this case, you may be unable to upgrade or downgrade the configurations of the instances. In this case, we recommend that you call the ModifyNodeSpec operation to individually change the configurations of each sharded cluster instance.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBInstanceIdstringYes

The ID of the instance whose configurations you want to change.

dds-bp1337621e8f****
NodesInfostringYes

The configuration information of the mongos nodes or shard nodes whose configurations 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}]}
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz****
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. You can perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, click Expenses to go to the Billing Management console. In the left-side navigation pane, click Orders. On the Orders page, find the order and complete the payment.

Default value: true.

true
EffectiveTimestringNo

The time when the changed configurations take effect. Valid values:

  • Immediately: The configurations immediately take effect.
  • MaintainTime: The configurations take effect during the maintenance window of the instance.
Note

Default value: Immediately.

Immediately
OrderTypestringNo

The type of configuration changes. Valid values:

  • UPGRADE
  • DOWNGRADE
Note This parameter is only applicable to instances whose billing method is subscription.
UPGRADE
CouponNostringNo

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

youhuiquan_promotion_option_id_for_blank
BusinessInfostringNo

The business information.

{“ActivityId":"000000000"}

Response parameters

ParameterTypeDescriptionExample
object
OrderIdstring

The order ID.

21012719476****
RequestIdstring

The request ID.

0637BC25-6895-5500-871F-1127CA34****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history