All Products
Document Center

ApsaraDB for MongoDB:ModifyParameters

Last Updated:Nov 06, 2023

Modifies the parameters of an ApsaraDB for MongoDB instance.

Operation Description


  • The instance must be in the Running state when you call this operation.
  • If you call this operation to modify specific instance parameters and the modification for part of the parameters can take effect only after an instance restart, the instance is automatically restarted after this operation is called. You can call the DescribeParameterTemplates operation to query the parameters that take effect only after the instance is restarted.


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.


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
  • dbinstance

Request parameters


The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.


The ID of the instance.

Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.

The ID of the mongos or shard node in the specified sharded cluster instance.

Note This parameter is valid only when DBInstanceId is set to the ID of a sharded cluster instance.

The instance parameters that you want to modify and their values. Specify this parameter in a JSON string. Sample format: {"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}.

Note You can call the DescribeParameterTemplates operation to query a list of default parameter templates.

The role of the instance. Valid values:

  • db: a shard node
  • cs: a Configserver node
  • mongos: a mongos node
  • logic: a sharded cluster instance

Response parameters


The ID of the request.



Sample success responses


  "RequestId": "36923CC2-DDAB-4B48-A144-DA92C1E19537"

Error codes

HTTP status codeError codeError message
400InvalidParameters.FormatSpecified parameters is not valid.

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