Página inicial do Docs → Desenvolver aplicações → Manual do MongoDB
getClusterParameter
Definição
getClusterParameter
getClusterParameter
é um comando administrativo para recuperar os valores dos parâmetros do cluster. Parâmetros de cluster são parâmetros configuráveis que afetam todos os nós em um cluster fragmentado.Para executar
getClusterParameter
, use o métododb.adminCommand( { command } )
.O comando
getClusterParameter
está disponível somente em instalações autogerenciadas. O comandogetClusterParameter
não está disponível no MongoDB Atlas.
Sintaxe
O comando tem a seguinte sintaxe:
db.adminCommand( { getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'" } )
Campos de comando
O comando utiliza os seguintes campos:
Campo | Tipo | Descrição |
---|---|---|
<parameter> | string ou matriz de strings | Você pode especificar uma das seguintes opções:
|
Comportamento
Você só pode executar
getClusterParameter
no reconhecimento de data centeradmin
. Se você executar o comando em qualquer outro reconhecimento de data center, o MongoDB retornará um erro.Você pode executar
getClusterParameter
em qualquer nó em um conjunto de réplicas ou cluster fragmentado.Quando você executa
getClusterParameter
emmongod
,getClusterParameter
retorna valores de parâmetro em cache.Ao executar
getClusterParameter
emmongos
,getClusterParameter
retorna o valor durável do parâmetro cluster do servidor de configuração.
Controle de acesso
Quando a autenticação está habilitada, o getClusterParameter
só funciona quando autenticado como um usuário com um role que tem acesso à ação getClusterParameter
.
Exemplos
Observação
A saída dos exemplos a seguir pode variar dependendo da configuração específica da execução do deployment do MongoDB.
Recuperar parâmetro de cluster único
A operação a seguir executa getClusterParameter
no banco de dados admin
usando um valor de hostName
para recuperar o valor de um parâmetro de cluster hipotético chamado hostName
:
use admin db.adminCommand( { getClusterParameter : "hostName" } )
Recuperar vários parâmetros de cluster
A operação a seguir executa getClusterParameter
no banco de dados admin
usando os valores hostName
e testParameter
para recuperar os valores dos parâmetros do cluster hipotético chamados hostName
e testParameter
:
use admin db.adminCommand( { getClusterParameter: [ "hostName", "testParameter" ] } )
Recuperar todos os parâmetros do cluster
A seguinte operação executa o getClusterParameter
com um valor de '*'
para recuperar os valores de todos os parâmetros do cluster:
use admin db.adminCommand( { getClusterParameter : '*' } )
Dica
Veja também:
setClusterParameter
para saber mais sobre esses parâmetros.