DescribeParameterTemplates - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the default parameter templates for MongoDB instances.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Engine	string	Yes	The database engine. Set the value to mongodb.	mongodb
EngineVersion	string	Yes	The database version number. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	5.0
Role	string	No	The role of the instance. Valid values: db: the shard role of a sharded cluster instance. cs: the config server role of a sharded cluster instance. mongos: the mongos role of a sharded cluster instance. normal: the role of a replica set instance. physical: the role of a single node instance. The default value is normal.	normal

Response elements

Element	Type	Description	Example
	object
ParameterCount	string	The number of parameters.	10
EngineVersion	string	The database version number.	5.0
Parameters	object
TemplateRecord	array<object>	A list of parameter templates.
	object
CheckingCode	string	The valid values of the parameter.	[0-65536]
ParameterName	string	The name of the parameter. For more information, see the official MongoDB documentation.	net.compression.compressors
ParameterValue	string	The default value of the parameter.	100
ForceModify	boolean	Indicates whether the parameter can be modified. false: The parameter cannot be modified. true: The parameter can be modified.	true
ForceRestart	boolean	Indicates whether a restart is required for the parameter modification to take effect. false: A restart is not required. The modification takes effect after you submit the modification. true: A restart is required for the modification to take effect.	false
ParameterDescription	string	The description of the parameter.	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
RequestId	string	The request ID.	BDA54203-9D61-54A3-A568-D281F785****
Engine	string	The database engine.	mongodb

Examples

Success response

JSON format

{
  "ParameterCount": "10",
  "EngineVersion": "5.0",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "net.compression.compressors",
        "ParameterValue": "100",
        "ForceModify": true,
        "ForceRestart": false,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100."
      }
    ]
  },
  "RequestId": "BDA54203-9D61-54A3-A568-D281F785****",
  "Engine": "mongodb"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.