ModifyNodeSpec-阿里云帮助中心

Modifies the specifications and storage space of nodes in a 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.

Note

This operation is applicable only to sharded cluster instances.

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:ModifyNodeSpec

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp1c0b990184****
NodeId	string	Yes	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 the value is a shard node ID, you must also specify the NodeStorage parameter.	s-bp143e1b1637****
NodeClass	string	No	The specifications of the shard or mongos node. For more information, see Instance specifications.	dds.mongos.standard
NodeStorage	integer	No	The storage space of the shard node. The step size is 10 GB. For local SSDs, valid values: 10 to 2000. For PL1 ESSDs, valid values: 20 to 16000.	20
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of this parameter on the client side. Make sure that the value is unique across different requests and contains a maximum of 64 ASCII characters. The value cannot contain non-ASCII characters.	ETnLKlblzczshOTUbOCz****
FromApp	string	No	The source of the request. Valid values: OpenApi: The request is sent from OpenAPI. mongo_buy: The request is sent from the console.	OpenApi
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. Make sure that your account has sufficient balance. false: Manual payment is enabled.	true
EffectiveTime	string	No	The effective period of the configuration change. Valid values: Immediately (default): The configuration change takes effect immediately. MaintainTime: The configuration change takes effect within the maintenance window of the instance. Valid values: Immediately : The configuration change takes effect immediately. MaintainTime : The configuration change takes effect within the maintenance window of the instance.	Immediately
SwitchTime	string	No	The time when the configuration change is executed. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note [Deprecated] This parameter is deprecated. Use the EffectiveTime parameter instead.	2022-01-05T03:18:53Z
OrderType	string	No	The order type. Valid values: UPGRADE: Upgrade. DOWNGRADE: Downgrade. Valid values: DOWNGRADE : Downgrade. UPGRADE : Upgrade.	UPGRADE
ReadonlyReplicas	integer	No	The number of read-only nodes in the shard node. Valid values: 0 to 5. The value must be an integer.	5
BusinessInfo	string	No	The additional parameter that contains business information.	{“ActivityId":"000000000"}
CouponNo	string	No	Specifies whether to use a coupon. Valid values: default or null (default): Use a coupon. youhuiquan_promotion_option_id_for_blank: Do not use a coupon.	default
TargetZoneId	string	No	The destination primary zone for zone migration. Important This parameter is supported only for cloud disk instances.	cn-hangzhou-h
TargetSecondaryZoneId	string	No	The destination secondary zone for zone migration. Important This parameter is supported only for cloud disk instances.	cn-hangzhou-e
TargetHiddenZoneId	string	No	The destination hidden zone for zone migration. Important This parameter is supported only for cloud disk instances.	cn-hangzhou-j
TargetVswitchId	string	No	Specifies whether to automatically align the primary node to the primary zone after operations such as specification changes for multi-zone instances. If you choose not to align the node, one primary/secondary switchover (transient disconnection) is avoided. Default value: true.	vsw-xxxxxxxx

Response elements

Element	Type	Description	Example
	object	The response.
OrderId	string	The order ID.	21084641369****
RequestId	string	The request ID.	61B05CCF-EBAB-4BF3-BA67-D77256A721E2

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	GadInstanceNotSupport	GAD Instance doesn't support the operation.	The operation is not supported by the GAD instance.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.