DescribeParameterTemplates - 查询实例默认的参数模板列表 - 云数据库 MongoDB

查询MongoDB实例默认的参数模板列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID，您可以调用 DescribeRegions 查询。	cn-hangzhou
Engine	string	是	数据库引擎，取值：mongodb。	mongodb
EngineVersion	string	是	数据库版本号。取值如下： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	5.0
Role	string	否	实例的角色类型，取值说明： db：分片集群 shard 角色。 cs：分片集群 config server 角色。 mongos：分片集群 mongos 角色。 normal: 副本集角色。 physical：单节点角色。默认值为 normal。	normal

返回参数

名称	类型	描述	示例值
	object
ParameterCount	string	参数个数。	10
EngineVersion	string	数据库版本号。	5.0
Parameters	array<object>	参数模板列表。
	object
CheckingCode	string	可修改参数的值。	[0-65536]
ParameterName	string	参数名称。详情请参见 MongoDB 官方文档	net.compression.compressors
ParameterValue	string	参数默认值。	100
ForceModify	boolean	参数是否处于可修改的状态。 false：不可修改。 true：可修改。	true
ForceRestart	boolean	修改参数后是否需要重启生效。 false：无需重启，提交后即生效。 true：需要重启生效。	false
ParameterDescription	string	参数描述。	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
RequestId	string	请求 ID。	BDA54203-9D61-54A3-A568-D281F785****
Engine	string	数据库引擎。	mongodb

示例

正常返回示例

JSON格式

{
  "ParameterCount": "10",
  "EngineVersion": "5.0",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "net.compression.compressors",
        "ParameterValue": "100",
        "ForceModify": true,
        "ForceRestart": false,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100."
      }
    ]
  },
  "RequestId": "BDA54203-9D61-54A3-A568-D281F785****",
  "Engine": "mongodb"
}

错误码

HTTP status code	错误码	错误信息
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.

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

变更历史

变更时间	变更内容概要	操作
2024-01-19	OpenAPI 错误码发生变更	查看变更详情
2024-01-10	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情