You can call this operation to query information about the parameter configuration of 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeParameters

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

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

Note If you specify this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
NodeId String No d-bpxxxxxxxx

The ID of the mongos or shard in the specified sharded cluster instance.

Note This parameter is only valid when you specify the DBInstanceId parameter to the ID of a sharded cluster instance.

Response parameters

Prameter Type Sample response Description
ConfigParameters Array

The list of configured parameters and their details.

Parameter
CheckingCode String [0-65536]

The range of the parameter value.

ForceRestart Boolean True

Indicates whether a restart is required for parameter modifications to take effect.

  • false: A restart is not required. Modifications take effect immediately after they are made.
  • true: A restart is required for modifications to take effect.
ModifiableStatus Boolean True

Indicates whether the parameter is modifiable.

  • false
  • true
ParameterDescription String The threshold in milliseconds at which the database profiler considers a query slow, default is 100.

The description of the parameter.

ParameterName String operationProfiling.slowOpThresholdMs

The name of the parameter.

ParameterValue String 2,000

The value of the parameter.

RequestId String 3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8

The ID of the request.

RunningParameters Array

The configuration of running parameters.

Parameter
CheckingCode String [33554432-268435456]

The range of the parameter value.

ForceRestart String false

Indicates whether a restart is required for parameter modifications to take effect.

  • false: A restart is not required. Modifications take effect immediately after they are made.
  • true: A restart is required for modifications to take effect.
ModifiableStatus String true

Indicates whether the parameter is modifiable.

  • false
  • true
ParameterDescription String The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)

The description of the parameter.

ParameterName String setParameter.internalQueryExecMaxBlockingSortBytes

The name of the parameter.

ParameterValue String 33554432

The value of the parameter.

EngineVersion String 4.0

The version number of the database.

Engine String mongodb

The database engine. Default value: mongodb.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/? Action=DescribeParameters
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameter>

Sample success response

XML format

<DescribeParametersResponse>
      <ConfigParameters>
            <Parameter>
                  <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100. </ParameterDescription>
                  <ParameterValue>200</ParameterValue>
                  <CheckingCode>[0-65536]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
            </Parameter>
      </ConfigParameters>
      <RequestId>3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8</RequestId>
      <RunningParameters>
            <Parameter>
                  <ParameterDescription></ParameterDescription>
                  <ParameterValue>zlib</ParameterValue>
                  <CheckingCode>snappy|zlib|disabled</CheckingCode>
                  <ForceRestart>true</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>net.compression.compressors</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>The level of database profiling, which inserts information about operation performance into the system.profile collection. 'off' for no profiling, 'slowOp' for only includes slow operations, 'all' for includes all operations, default is 'slowOp'. </ParameterDescription>
                  <ParameterValue>slowOp</ParameterValue>
                  <CheckingCode>off|slowOp|all</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>operationProfiling.mode</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100. </ParameterDescription>
                  <ParameterValue>220</ParameterValue>
                  <CheckingCode>[0-65536]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)</ParameterDescription>
                  <ParameterValue>600000</ParameterValue>
                  <CheckingCode>[1-2147483647]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>setParameter.cursorTimeoutMillis</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)</ParameterDescription>
                  <ParameterValue>33554432</ParameterValue>
                  <CheckingCode>[33554432-268435456]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>setParameter.internalQueryExecMaxBlockingSortBytes</ParameterName>
            </Parameter>
      </RunningParameters>
      <EngineVersion>4.0</EngineVersion>
      <Engine>mongodb</Engine>
</DescribeParametersResponse>

JSON format

{
    "ConfigParameters": {
        "Parameter": [
            {
                "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
                "ParameterValue": "200",
                "CheckingCode": "[0-65536]",
                "ForceRestart": false,
                "ModifiableStatus": true,
                "ParameterName": "operationProfiling.slowOpThresholdMs"
            }
        ]
    },
    "RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
    "RunningParameters": {
        "Parameter": [
            {
                "ParameterDescription": "",
                "ParameterValue": "zlib",
                "CheckingCode": "snappy|zlib|disabled",
                "ForceRestart": "true",
                "ModifiableStatus": "true",
                "ParameterName": "net.compression.compressors"
            },
            {
                "ParameterDescription": "The level of database profiling, which inserts information about operation performance into the system.profile collection. 'off' for no profiling, 'slowOp' for only includes slow operations, 'all' for includes all operations, default is 'slowOp'.",
                "ParameterValue": "slowOp",
                "CheckingCode": "off|slowOp|all",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "operationProfiling.mode"
            },
            {
                "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
                "ParameterValue": "220",
                "CheckingCode": "[0-65536]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "operationProfiling.slowOpThresholdMs"
            },
            {
                "ParameterDescription": "The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)",
                "ParameterValue": "600000",
                "CheckingCode": "[1-2147483647]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "setParameter.cursorTimeoutMillis"
            },
            {
                "ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
                "ParameterValue": "33554432",
                "CheckingCode": "[33554432-268435456]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes"
            }
        ]
    },
    "EngineVersion": "4.0",
    "Engine": "mongodb"
}

Error codes

Http status code Error code Error message Description
404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found. The error message returned when the specified instance type does not exists. Verify the specified instance type.
403 IncorrectDBInstanceType Current DB instance type does not support this operation. The error message returned because the operation is not supported by the current instance type.

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