Docs 菜单
Docs 主页
/
MongoDB Manual
/
参考
/
数据库命令
/
管理

getClusterParameter

在此页面上

定义

getClusterParameter

getClusterParameter is an administrative command for retrieving the values of cluster parameters. Cluster parameters are configurable parameters that affect all nodes in a sharded cluster.

To run getClusterParameter, use the db.adminCommand( { command } ) method.

getClusterParameter 命令仅在自托管安装中可用。getClusterParameter 命令在 MongoDB Atlas 中不可用。

兼容性

此命令可用于以下环境中托管的部署：

注意

所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息，请参阅不支持的命令。

语法

该命令具有以下语法：

db.adminCommand(
   {
     getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'"
   }
)

命令字段

该命令接受以下字段：

字段
类型
说明

<parameter>

String or array of strings

You can specify one of the following:

  • The name of the parameter you want to retrieve.

  • An array with the names of multiple parameters.

  • '*', to return values for all parameters available to getClusterParameter.

行为

  • You can only run getClusterParameter on the admin database. If you run the command on any other database, MongoDB returns an error.

  • You can run getClusterParameter on any node in a replica set or sharded cluster.

  • When you run getClusterParameter on mongod, getClusterParameter returns cached parameter values.

  • When you run getClusterParameter on mongos, getClusterParameter returns the 持久性 value of the cluster parameter from the config server.

访问控制

When 身份验证 is enabled, getClusterParameter only works when authenticated as a user with a role that has access to the getClusterParameter action.

示例

注意

The output of the following examples may vary depending on the specific configuration of the running MongoDB deployment.

Retrieve Single Cluster Parameter

The following operation runs getClusterParameter on the admin database using a value of hostName to retrieve the value for a hypothetical cluster parameter named hostName:

use admin
db.adminCommand( { getClusterParameter : "hostName" } )

Retrieve Multiple Cluster Parameters

The following operation runs getClusterParameter on the admin database using the values hostName and testParameter to retrieve the values for hypothetical cluster parameters named hostName and testParameter:

use admin
db.adminCommand( { getClusterParameter: [ "hostName", "testParameter" ] } )

Retrieve All Cluster Parameters

The following operation runs getClusterParameter with a value of '*' to retrieve the values from all cluster parameters:

use admin
db.adminCommand( { getClusterParameter : '*' } )

提示

另请参阅：

setClusterParameter了解有关这些参数的更多信息。

后退

getAuditConfig

来年

getDefaultRWConcern