All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeParameterTemplates

Last Updated:Mar 15, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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

cn-hangzhou
EnginestringYes

The database engine of the instance. Set the value to MongoDB.

mongodb
EngineVersionstringYes

The database engine version of the instance. Valid values:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
5.0
RolestringNo

The role of the instance. Valid values:

  1. db: a shard node.

  2. cs: a Configserver node.

  3. mongos: a mongos node.

  4. normal: a replica set node.

  5. physical: a standalone node.

default: normal

normal

Response parameters

ParameterTypeDescriptionExample
object
ParameterCountstring

The number of parameters that are supported by the instance.

10
EngineVersionstring

The database engine version of the instance.

5.0
Parametersobject []

Details about the parameter templates.

CheckingCodestring

The value range of modifiable parameters.

[0-65536]
ParameterNamestring

The name of the parameter.

net.compression.compressors
ParameterValuestring

The default value of the parameter.

100
ForceModifyboolean

Indicates whether the parameter is modifiable.

  • false: The parameter cannot be modified.
  • true: The parameter can be modified.
true
ForceRestartboolean

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
ParameterDescriptionstring

The description of the parameter.

The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
RequestIdstring

The ID of the request.

BDA54203-9D61-54A3-A568-D281F785****
Enginestring

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 codeError codeError message
400InvalidEngineVersion.MalformedSpecified engine version is not valid.
400InvalidEngine.MalformedSpecified engine is not valid.

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

Change history

Change timeSummary of changesOperation
2024-01-19The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2024-01-10The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Role