DescribeParameterTemplates - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the list of default parameter templates for ApsaraDB for MongoDB 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

There is currently no authorization information disclosed in the API.

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
Engine	string	Yes	The database engine of the instance. Set the value to MongoDB.	mongodb
EngineVersion	string	Yes	The database engine version of the instance. Valid values: 5.0 4.4 4.2 4.0 3.4	5.0
Role	string	No	The role of the instance. Valid values: db: a shard node. cs: a Configserver node. mongos: a mongos node. normal: a replica set node. physical: a standalone node. default: normal	normal

Response parameters

Parameter	Type	Description	Example
	object
ParameterCount	string	The number of parameters that are supported by the instance.	10
EngineVersion	string	The database engine version of the instance.	5.0
Parameters	array<object>	Details about the parameter templates.
	object
CheckingCode	string	The value range of modifiable parameters.	[0-65536]
ParameterName	string	The name of the parameter.	net.compression.compressors
ParameterValue	string	The default value of the parameter.	100
ForceModify	boolean	Indicates whether the parameter is modifiable. false: The parameter cannot be modified. true: The parameter can be modified.	true
ForceRestart	boolean	Indicates whether a restart is required for parameter modifications to take effect. false: A restart is not required. Parameter modifications immediately take effect. true: A restart is required for parameter modifications 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 ID of the request.	BDA54203-9D61-54A3-A568-D281F785****
Engine	string	The database engine of the instance.	mongodb

Examples

Sample success responses

JSONformat

{
  "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
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.

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

Change history

Change time	Summary of changes	Operation
2024-01-19	The Error code has changed	View Change Details
2024-01-10	The Error code has changed. The request parameters of the API has changed	View Change Details