getClusterParameter
定义
getClusterParameter
getClusterParameter
是用于检索集群参数值的管理命令。集群参数是可配置的参数,会影响分片集群中的所有节点。要运行
getClusterParameter
,请使用db.adminCommand( { command } )
方法。getClusterParameter
命令仅在自托管安装中可用。getClusterParameter
命令在 MongoDB Atlas 中不可用。
语法
该命令具有以下语法:
db.adminCommand( { getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'" } )
命令字段
该命令接受以下字段:
字段 | 类型 | 说明 |
---|---|---|
<parameter> | 字符串或字符串数组 | 您可以指定以下其中一项:
|
行为
您只能在
admin
数据库上运行getClusterParameter
。 如果在任何其他数据库上运行该命令,MongoDB 都会返回错误。您可以在副本集或分片集群中的任何节点上运行
getClusterParameter
。当您在
mongod
上运行getClusterParameter
时,getClusterParameter
会返回缓存的参数值。当您在 上运行 时, 会从
getClusterParameter
mongos
getClusterParameter
配置服务器 返回集群参数的 持久 值。
访问控制
启用身份验证后, getClusterParameter
仅当用户身份验证为具有有权访问getClusterParameter
操作的角色时才起作用。
举例
注意
以下示例的输出可能会有所不同,具体取决于正在运行的 MongoDB 部署的具体配置。
检索单个集群参数
以下操作使用值hostName
在admin
数据库上运行getClusterParameter
,以检索名为hostName
的假设集群参数的值:
use admin db.adminCommand( { getClusterParameter : "hostName" } )
检索多个集群参数
以下操作使用值hostName
和testParameter
在admin
数据库上运行getClusterParameter
,以检索名为hostName
和testParameter
的假设集群参数的值:
use admin db.adminCommand( { getClusterParameter: [ "hostName", "testParameter" ] } )
检索所有集群参数
以下操作运行值为'*'
的getClusterParameter
,以检索所有集群参数的值:
use admin db.adminCommand( { getClusterParameter : '*' } )
提示
另请参阅:
setClusterParameter
了解有关这些参数的更多信息。