Modifies the parameters of an AsparaDB for MongoDB instance.


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


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 ModifyParameters

The operation that you want to perform. Set the value to ModifyParameters.

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-bp19f409d75****

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.
NodeId String No d-bp1b7bb3bbe****

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.
Parameters String Yes null

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.
CharacterType String No db

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

Parameter Type Example Description
RequestId String 36923CC2-DDAB-4B48-A144-DA92C1E19537

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

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

Error codes

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