ModifyNodeSpec - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

Note This operation applies only to sharded cluster instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyNodeSpec	The operation that you want to perform. Set the value to ModifyNodeSpec.
RegionId	String	No	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
DBInstanceId	String	Yes	dds-bp1c0b990184****	The ID of the instance.
NodeId	String	Yes	s-bp143e1b1637****	The ID of the shard or mongos node in the sharded cluster instance. You can call the DescribeDBInstanceAttribute operation to query the node ID. Note If you set this parameter to the ID of a shard node, you must also specify the NodeStorage parameter.
NodeClass	String	Yes	dds.mongos.standard	The instance type of the shard or mongos node. For more information, see Instance types.
NodeStorage	Integer	No	20	The storage capacity of the shard node. Unit: GB. Valid values are 10 to 2000 if the instance uses local SSDs. Valid values are 20 to 16000 if the instance uses enhanced SSDs (ESSDs) at PL1. Note The value must be a multiple of 10.
ClientToken	String	No	ETnLKlblzczshOTUbOCz****	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 make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.
FromApp	String	No	OpenApi	The source of the request. Valid values: OpenApi: the ApsaraDB for MongoDB API mongo_buy: the ApsaraDB for MongoDB console
AutoPay	Boolean	No	true	Specifies whether to enable automatic payment. Default value: true. 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 pay for the instance.
EffectiveTime	String	No	Immediately	The time when the changed configurations take effect. Default value: Immediately. Valid values: Immediately: The new configurations immediately take effect MaintainTime: The new configurations take effect during the maintenance window of the instance.
SwitchTime	String	No	2022-01-05T03:18:53Z	The execution time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
OrderType	String	No	UPGRADE	The order type. Valid values: UPGRADE DOWNGRADE
ReadonlyReplicas	Integer	No	5	The number of read-only nodes in the shard node. Valid values: 0 to 5. The value must be an integer. Default value: 0.
BusinessInfo	String	No	{“ActivityId":"000000000"}	The business information. This is an additional parameter.
CouponNo	String	No	youhuiquan_promotion_option_id_for_blank	The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.

Response parameters


Parameter	Type	Example	Description
RequestId	String	61B05CCF-EBAB-4BF3-BA67-D77256A721E2	The ID of the request.
OrderId	String	21084641369****	The ID of the order.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=ModifyNodeSpec
&DBInstanceId=dds-bp1c0b990184****
&NodeId=s-bp143e1b1637****
&NodeClass=dds.mongos.standard
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyNodeSpecResponse>
    <RequestId>61B05CCF-EBAB-4BF3-BA67-D77256A721E2</RequestId>
    <OrderId>21084641369****</OrderId>
</ModifyNodeSpecResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "61B05CCF-EBAB-4BF3-BA67-D77256A721E2",
  "OrderId" : "21084641369****"
}

Error codes

For a list of error codes, visit the API Error Center.