All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeParameters

    Document Center

    ApsaraDB for MongoDB:DescribeParameters

    Last Updated:Jan 17, 2023

    You can call this operation to query parameter configurations of an ApsaraDB for MongoDB instance.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:DescribeParameters READ
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    RegionId string No

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

    		 cn-hangzhou
    DBInstanceId string Yes

    The ID of the instance.

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

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

    Note This parameter is valid only if you set the DBInstanceId parameter to the ID of a sharded cluster instance.
    		d-bpxxxxxxxx
    CharacterType string No

    The type of the database account. Valid values:

    • mongos: an account that can be used to log on to mongos
    • shard: an account that can be used to log on to shards
    		 mongos

    Response parameters

    Parameter Type Description Example
    object
    RunningParameters array

    The list of instance parameters that have taken effect.
    object
    CheckingCode string

    The valid values of the parameter.

    		 [33554432-268435456]
    ParameterName string

    The name of the parameter.

    		 setParameter.internalQueryExecMaxBlockingSortBytes
    ParameterValue string

    The value of the parameter.

    		 33554432
    ForceRestart string

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

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

    The description of the parameter.

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

    Indicates whether the parameter is modifiable.

    • false: The parameter is not modifiable.
    • true: The parameter is modifiable.
    		 true
    EngineVersion string

    The version number of the database.

    		 4.0
    RequestId string

    The ID of the request.

    		 3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
    ConfigParameters array

    The list of instance parameters in the configuration template.
    object
    CheckingCode string

    The valid values of the parameter.

    		 [0-65536]
    ParameterName string

    The name of the parameter.

    		 operationProfiling.slowOpThresholdMs
    ParameterValue string

    The value of the parameter.

    		 200
    ForceRestart boolean

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

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

    The description of the parameter.

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

    Indicates whether the parameter is modifiable.

    • false: The parameter is not modifiable.
    • true: The parameter is modifiable.
    		 true
    Engine string

    The database engine. Default value: mongodb.

    		 mongodb

    Example

    Normal return example

    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"
      }
    ]
  },
  "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 code Error code Error message
    403 IncorrectDBInstanceType Current DB instance type does not support this operation.
    404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found.

    For a list of error codes, visit the API error center.