调用DescribeParameters接口查询MongoDB实例的参数配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeParameters

要执行的操作，取值：DescribeParameters。

DBInstanceId String 是 dds-bpxxxxxxxx

实例ID。

说明 当本参数传入的是分片集群实例ID时，还需要传入 NodeId参数。
NodeId String 否 d-bpxxxxxxxx

分片集群实例中的Mongos节点ID或Shard节点ID。

说明 当 DBInstanceId参数传入的是分片集群实例ID时，本参数才可用。
CharacterType String 否 mongos

账号类型，取值为：

  • mongos：mongos节点的登录账号。
  • shard：shard节点的登录账号。

返回数据

名称 类型 示例值 描述
ConfigParameters Array

配置中的参数配置信息列表。
Parameter
CheckingCode String [0-65536]

参数取值范围。
ForceRestart Boolean true

修改参数后是否需要重启生效。

  • false：无需重启，提交后即生效。
  • true：需要重启生效。
ModifiableStatus Boolean true

参数是否处于可修改的状态。

  • false：不可修改。
  • true：可修改。
ParameterDescription String The threshold in milliseconds at which the database profiler considers a query slow, default is 100.

参数描述。
ParameterName String operationProfiling.slowOpThresholdMs

参数名。
ParameterValue String 200

参数值。
RequestId String 3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8

请求ID。
RunningParameters Array

当前运行的参数配置信息列表。
Parameter
CheckingCode String [33554432-268435456]

参数取值范围。
ForceRestart String false

修改参数后是否需要重启生效。

  • false：无需重启，提交后即生效。
  • true：需要重启生效。
ModifiableStatus String true

参数是否处于可修改的状态。

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

参数描述。
ParameterName String setParameter.internalQueryExecMaxBlockingSortBytes

参数名。
ParameterValue String 33554432

参数值。
EngineVersion String 4.0

数据库版本号。
Engine String mongodb

数据库引擎，默认返回mongodb。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<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 格式 

{
	"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"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found. 该实例规格不存在，请您检查输入的参数是否正确。
403 IncorrectDBInstanceType Current DB instance type does not support this operation. 当前的实例类型不支持此操作。

访问错误中心查看更多错误码。