DescribeParameters - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the parameter settings of an ApsaraDB for MongoDB instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeParameters

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	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
NodeId	string	No	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
CharacterType	string	No	The role of the instance. Valid values: db: a shard node. cs: a Configserver node. mongos: a mongos node.	mongos
ExtraParam	string	No	The parameter that is available in the future.	terrform

Response elements

Element	Type	Description	Example
	object
RunningParameters	object
Parameter	array<object>	The settings of the 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. Valid values: false: A restart is not required. Modifications take effect immediately. true: A restart is required for parameter 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 value can be modified. Valid values: false: The parameter value cannot be modified. true: The parameter value can be modified.	true
CharacterType	string	实例的角色类型，取值说明： db：shard 角色。 cs：config server 角色。 mongos：mongos 角色。	db
EngineVersion	string	The database engine version of the instance.	4.0
RequestId	string	The request ID.	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	The parameter settings 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. Valid values: false: A restart is not required. Modifications take effect immediately. true: A restart is required for parameter 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 value can be modified. Valid values: false: The parameter value cannot be modified. true: The parameter value can be modified.	true
Engine	string	The database engine of the instance. Default value: mongodb.	mongodb

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	The specified DB instance type is not found.	Invalid instance type. Specify another instance type.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.