文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考参数管理DescribeDBInstanceParameters
复制全文
下载 pdfDescribeDBInstanceParameters
文档反馈
问问助手调用 DescribeDBInstanceParameters 接口查询目标 MongoDB 实例支持的参数列表。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 必选 示例值：mongo-replica-55d593549354
实例 ID。
说明
ParameterRole String 可选 示例值：Node
目标参数所属的节点类型，取值范围如下：
- Node：副本集实例节点。
- Shard：分片集群实例中的 Shard 节点。
- ConfigServer：分片集群实例中的 ConfigServer 节点。
- Mongos：分片集群实例中的 Mongos 节点。
说明
- 当传入的 InstanceId 为副本集实例 ID 时，ParameterRole 可留空或设置为 Node。
- 当传入的 InstanceId 为分片集群实例 ID 时，若ParameterRole不填，默认会返回分片集群中所有类型节点的参数。
ParameterNames String 可选 示例值：connPoolMaxConnsPerHost
需要查找的参数名称。
说明
- 支持模糊查询，不区分大小写。例如，您可以传入 pool 来查询所有名称中包含 pool 的参数详情。
- 若该参数留空，默认查询当前实例中所有参数的详情。
返回参数
InstanceId String 示例值：mongo-replica-55d593549354
实例 ID。
DBEngine String 示例值：MongoDB
数据库引擎。取值固定为 MongoDB。
DBEngineVersion String 示例值：MongoDB_5_0
数据库引擎版本。
Total String 示例值：1
符合查询要求的参数个数。
InstanceParameters Object[] 示例值：
符合查询要求的所有参数详情列表。
ForceModify Boolean 示例值：true
目标参数是否支持修改参数值。取值范围如下：
- true：支持修改。
- false：不支持修改。
CheckingCode String 示例值：200 - 2000
参数的取值范围。
ForceRestart Boolean 示例值：true
修改后，新的参数值是否需要重启实例才生效。取值范围如下：
- true：需要重启。
- false：不需要重启。
ParameterRole String 示例值：Node
目标参数所属的节点类型，取值范围如下：
- Node：副本集实例节点。
- Shard：分片集群实例中的 Shard 节点。
- ConfigServer：分片集群实例中的 ConfigServer 节点。
- Mongos：分片集群实例中的 Mongos 节点。
ParameterType String 示例值：Integer
参数值的数据类型，取值范围如下：
- Integer：整数类型。
- String：字符串类型。
- Boolean：布尔类型。
ParameterNames String 示例值：connPoolMaxConnsPerHost
参数名。
ParameterValue String 示例值：1
目标参数的当前取值。
ParameterDescription String 示例值：设置当前实例或节点的全局连接池最大容量
参数描述。
ParameterDefaultValue String 示例值：600
目标参数的默认值。
示例
请求示例
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
"InstanceId": "mongo-replica-55d593549354",
"ParameterNames": "connPoolMaxConnsPerHost"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2022052716480301022508219902F002F0",
"Action": "DescribeDBInstanceParameters",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": {
"DBEngine": "MongoDB",
"DBEngineVersion": "MongoDB_4_0",
"InstanceId": "mongo-replica-55d593549354",
"InstanceParameters": [
{
"CheckingCode": "200 - 2000",
"ForceModify": true,
"ForceRestart": true,
"ParameterDefaultValue": "600",
"ParameterDescription": "表示当前实例与其他mongod实例通信的连接池的最大连接数",
"ParameterNames": "connPoolMaxConnsPerHost",
"ParameterRole": "Node",
"ParameterType": "Integer",
"ParameterValue": "601"
}
],
"Total": "1"
}
}
错误码
最近更新时间：2026.06.17 16:52:56
这个页面对您有帮助吗？
有用
有用
无用
无用