DescribeParameters - 查询实例的参数配置信息 - 云数据库 MongoDB

查询MongoDB实例的参数配置信息。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeParameters

get

*dbinstance

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

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明当本参数传入的是分片集群实例 ID 时，还需要传入 NodeId 参数。	dds-bpxxxxxxxx
NodeId	string	否	分片集群实例中的 Mongos 节点 ID 或 Shard 节点 ID。说明当 DBInstanceId 参数传入的是分片集群实例 ID 时，本参数才可用。	d-bpxxxxxxxx
CharacterType	string	否	实例的角色类型，取值说明： db：shard 角色。 cs：config server 角色。 mongos：mongos 角色。	mongos
ExtraParam	string	否	扩展参数。	terrform

返回参数

名称	类型	描述	示例值
	object
RunningParameters	object
Parameter	array<object>	当前运行的参数配置信息列表。
	object
CheckingCode	string	参数取值范围。	[33554432-268435456]
ParameterName	string	参数名。	setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValue	string	参数值。	33554432
ForceRestart	string	修改参数后是否需要重启生效。 false：无需重启，提交后即生效。 true：需要重启生效。	false
ParameterDescription	string	参数描述。	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatus	string	参数是否处于可修改的状态。 false：不可修改。 true：可修改。	true
CharacterType	string	实例的角色类型，取值说明： db：shard 角色。 cs：config server 角色。 mongos：mongos 角色。	db
EngineVersion	string	数据库版本号。	4.0
RequestId	string	请求 ID。	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	配置中的参数配置信息列表。
	object
CheckingCode	string	参数取值范围。	[0-65536]
ParameterName	string	参数名。	operationProfiling.slowOpThresholdMs
ParameterValue	string	参数值。	200
ForceRestart	boolean	修改参数后是否需要重启生效。 false：无需重启，提交后即生效。 true：需要重启生效。	true
ParameterDescription	string	参数描述。	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatus	boolean	参数是否处于可修改的状态。 false：不可修改。 true：可修改。	true
Engine	string	数据库引擎，默认返回 mongodb。	mongodb

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	The specified DB instance type is not found.	所选实例规格不存在，请重新选择。

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

变更历史

更多信息，参考变更详情。