All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyNodeSpecBatch

Last Updated:Nov 06, 2023

Modifies the configurations of one or more 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 to only sharded cluster instances.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region. You can call the DescribeRegions operation to query the latest available regions.

cn-hangzhou
DBInstanceIdstringYes

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

dds-bp1337621e8f****
NodesInfostringYes

The configuration information of the mongos nodes or shard nodes whose configurations you want to modify. 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 token, but you must make sure that the token 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 for the instance. 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, choose Expenses > User Center 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 modified 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 modifications. Valid values:

  • UPGRADE
  • DOWNGRADE
Note This parameter is available only if the billing method of the instance 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 ID of the order.

21012719476****
RequestIdstring

The ID of the request.

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.