All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyNodeSpec

Last Updated:Jan 16, 2024

Changes the specifications and storage capacity of a node of an ApsaraDB for MongoDB sharded cluster instance.

Operation description

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

Note This operation is applicable 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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dds:ModifyNodeSpecWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

dds-bp1c0b990184****
NodeIdstringYes

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 the shard node, you must also specify the NodeStorage parameter.
s-bp143e1b1637****
NodeClassstringYes

The specifications of the shard or mongos node. For more information, see Instance types.

dds.mongos.standard
NodeStorageintegerNo

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.
20
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****
FromAppstringNo

The source of the request. Valid values:

  • OpenApi: the ApsaraDB for MongoDB API
  • mongo_buy: the ApsaraDB for MongoDB console
OpenApi
AutoPaybooleanNo

Specifies whether to enable automatic payment. Valid values:

  • true (default): 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.
true
EffectiveTimestringNo

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

  • Immediately (default): The new configurations immediately take effect
  • MaintainTime: The new configurations take effect during the maintenance window of the instance.
Immediately
SwitchTimestringNo

The execution time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2022-01-05T03:18:53Z
OrderTypestringNo

The order type. Valid values:

  • UPGRADE
  • DOWNGRADE
UPGRADE
ReadonlyReplicasintegerNo

The number of read-only nodes in the shard node.

Valid values: 0 to 5. The value must be an integer. Default value: 0.

5
BusinessInfostringNo

The business information. This is an additional parameter.

{“ActivityId":"000000000"}
CouponNostringNo

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

youhuiquan_promotion_option_id_for_blank

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The ID of the request.

61B05CCF-EBAB-4BF3-BA67-D77256A721E2
OrderIdstring

The ID of the order.

21084641369****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2021-04-29The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: SwitchTime
    Added Input Parameters: BusinessInfo
    Added Input Parameters: CouponNo