All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeParameters

Last Updated:Mar 15, 2024

Queries the parameter settings of an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeParametersREAD
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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-bpxxxxxxxx
NodeIdstringNo

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

Note This parameter is valid when the DBInstanceId parameter is set to the ID of a sharded cluster instance.
d-bpxxxxxxxx
CharacterTypestringNo

The role of the instance. Valid values:

  • db: a shard node.
  • cs: a Configserver node.
  • mongos: a mongos node.
mongos
ExtraParamstringNo

The parameter that is available in the future.

terrform

Response parameters

ParameterTypeDescriptionExample
object
RunningParametersobject []

The settings of the parameters that have taken effect.

CheckingCodestring

The valid values of the parameter.

[33554432-268435456]
ParameterNamestring

The name of the parameter.

setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValuestring

The value of the parameter.

33554432
ForceRestartstring

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

  • false: A restart is not required. Modifications take effect immediately.
  • true: A restart is required for parameter modifications to take effect.
false
ParameterDescriptionstring

The description of the parameter.

The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatusstring

Indicates whether the parameter value can be modified. Valid values:

  • false: The parameter value cannot be modified.
  • true: The parameter value can be modified.
true
EngineVersionstring

The database engine version of the instance.

4.0
RequestIdstring

The request ID.

3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParametersobject []

The parameter settings in the configuration template.

CheckingCodestring

The valid values of the parameter.

[0-65536]
ParameterNamestring

The name of the parameter.

operationProfiling.slowOpThresholdMs
ParameterValuestring

The value of the parameter.

200
ForceRestartboolean

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

  • false: A restart is not required. Modifications take effect immediately.
  • true: A restart is required for parameter modifications to take effect.
true
ParameterDescriptionstring

The description of the parameter.

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

Indicates whether the parameter value can be modified. Valid values:

  • false: The parameter value cannot be modified.
  • true: The parameter value can be modified.
true
Enginestring

The database engine of the instance. Default value: mongodb.

mongodb

Examples

Sample success responses

JSONformat

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[33554432-268435456]",
        "ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes",
        "ParameterValue": "33554432",
        "ForceRestart": "false",
        "ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
        "ModifiableStatus": "true",
        "CharacterType": "db"
      }
    ]
  },
  "EngineVersion": "4.0",
  "RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "operationProfiling.slowOpThresholdMs",
        "ParameterValue": "200",
        "ForceRestart": true,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
        "ModifiableStatus": true
      }
    ]
  },
  "Engine": "mongodb"
}

Error codes

HTTP status codeError codeError messageDescription
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.This operation is not supported for the specified instance type.
404InvalidDBInstanceClass.NotFoundThe specified DB instance type is not found.Invalid instance type. Specify another instance type.

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

Change history

Change timeSummary of changesOperation
2023-03-15The 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: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ExtraParam