ModifyParameters - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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.

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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:ModifyParameters	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	Yes	The instance ID. Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.	dds-bp19f409d75****
NodeId	string	No	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.	d-bp1b7bb3bbe****
Parameters	string	Yes	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.	{"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"}
CharacterType	string	No	The role of the instance. Valid values: db: a shard node. cs: a Configserver node. mongos: a mongos node.	db

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
RequestId	string	The request ID.	36923CC2-DDAB-4B48-A144-DA92C1E19537

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidParameters.Format	Specified parameters is not valid.

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

Change history

Change time	Summary of changes	Operation
2024-08-27	The Error code has changed	View Change Details
2024-07-23	The Error code has changed	View Change Details
2024-06-25	The Error code has changed	View Change Details