全部产品
Search
文档中心

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

更新时间:Mar 15, 2024

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
Enginestring

数据库引擎,取值:mongodb

mongodb
EngineVersionstring

数据库版本号。取值如下:

  • 7.0
  • 6.0
  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
5.0
Rolestring

实例的角色类型,取值说明:

  • db:分片集 shard 角色。
  • cs:分片集 config server 角色。
  • mongos:分片集 mongos 角色。
  • normal: 副本集角色。
  • physical:单节点角色。

默认值为 normal。

normal

返回参数

名称类型描述示例值
object
ParameterCountstring

参数个数。

10
EngineVersionstring

数据库版本号。

5.0
Parametersobject []

参数模板列表。

CheckingCodestring

可修改参数的值。

[0-65536]
ParameterNamestring

参数名称。

详情请参见 MongoDB 官方文档

net.compression.compressors
ParameterValuestring

参数默认值。

100
ForceModifyboolean

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

  • false:不可修改。
  • true:可修改。
true
ForceRestartboolean

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

  • false:无需重启,提交后即生效。
  • true:需要重启生效。
false
ParameterDescriptionstring

参数描述。

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

请求 ID。

BDA54203-9D61-54A3-A568-D281F785****
Enginestring

数据库引擎。

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错误码错误信息
400InvalidEngineVersion.MalformedSpecified engine version is not valid.
400InvalidEngine.MalformedSpecified engine is not valid.

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

变更历史

变更时间变更内容概要操作
2024-01-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2024-01-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Role