ModifyNodeSpec - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.

Operation description

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 you set this parameter to the ID of a shard node, you must also specify the NodeStorage parameter.	s-bp143e1b1637****
NodeClass	string	No	The instance type of the shard or Mongos node. For more information, see Instance types.	dds.mongos.standard
NodeStorage	integer	No	The storage space of the shard node. The step size is 10. Unit: GB. SSD local disk: 10 to 2000. ESSD PL1 disk: 20 to 16000.	20
ClientToken	string	No	A 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****
FromApp	string	No	The source of the request. Valid values: OpenApi: The request is from OpenAPI. mongo_buy: The request is from the console.	OpenApi
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true (default): Enables automatic payment. Make sure that your account has a sufficient balance. false: Disables automatic payment. You must manually pay for the order.	true
EffectiveTime	string	No	The effective time of the configuration change. Valid values: Immediately (default): The change takes effect immediately. MaintainTime: The change takes effect during the O&M window of the instance.	Immediately
SwitchTime	string	No	The time when the configuration change takes effect. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note This parameter is deprecated. Use the EffectiveTime parameter instead.	2022-01-05T03:18:53Z
OrderType	string	No	The order type. Valid values: UPGRADE: upgrades the instance configuration. DOWNGRADE: downgrades the instance configuration.	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 business information. This is an additional parameter.	{“ActivityId":"000000000"}
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
TargetZoneId	string	No	The primary zone to which you want to migrate the instance. Important This parameter is applicable only to instances that use disks.	cn-hangzhou-h
TargetSecondaryZoneId	string	No	The secondary zone to which you want to migrate the instance. Important This parameter is applicable only to instances that use disks.	cn-hangzhou-e
TargetHiddenZoneId	string	No	The hidden zone to which you want to migrate the instance. Important This parameter is applicable only to instances that use disks.	cn-hangzhou-j
TargetVswitchId	string	No	The ID of the vSwitch in the destination zone. Important This parameter is applicable only to instances that use disks.	vsw-xxxxxxxx

Response elements

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

Examples

Success response

JSON format

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

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.