Começar a monitorar um host

Nesta página

Resource

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

Comece a monitorar um novo processo do MongoDB. O Monitoramento começa a monitorar o processo MongoDB no nome do host e na porta que você especifica. Ops Manager conhece apenas as informações que você fornece. O documento de resposta inclui valores em branco até que o Ops Manager conclua a descoberta da configuração dos processos do MongoDB.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/hosts

Parâmetros do caminho da solicitação

Parâmetro	Tipo	necessidade	Descrição
ID do projeto	string	Obrigatório	Identificador único do projeto que possui este processo MongoDB.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
Status	Código de resposta HTTP
envelope	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
alertsEnabled	booleano	Opcional	Defina como `true` se os alertas precisarem ser habilitados para esse processo do MongoDB.
authMechanismName	string	Opcional	Especifique qual mecanismo de autenticação deve ser usado para se conectar a esse processo do MongoDB. Os valores possíveis são: `MONGODB_CR` (Isto abrange SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
nome do host	string	Obrigatório	Defina o nome de host primário que o Ops Manager deve usar para se conectar a essa instância do MongoDB.
logsEnabled	booleano	Opcional	Defina como `true` se o Ops Manager precisar coletar registros para esse processo do MongoDB.
Senha	string	Opcional	Senha associada a `username` para se conectar a este processo do MongoDB. Configure este parâmetro se `"authMechanismName" : "MONGODB_CR"` O Ops Manager não inclui este parâmetro em nenhum host \|\| resposta.
Porta	número	Obrigatório	Porta na qual o processo do MongoDB escuta.
profilerEnabled	booleano	Opcional	Sinalizador que indica se o Ops Manager coleta informações de perfil desse processo do MongoDB.
sslEnabled	booleano	Condicional	Sinalizador que indica se o TLS deve ser habilitado para este processo do MongoDB. Defina como `true` se `"authMechanismName" : "MONGODB_X509"`.
nome de usuário	string	Condicional	O nome de usuário necessário para se conectar a este processo MongoDB. Necessário se `"authMechanismName" : "MONGODB_CR"`

Resposta

Nome	Tipo	Descrição
Aliases	array de strings	Array de combinações alternativas de nome de host e porta que o Ops Manager encontrou para o processo do MongoDB. Essas combinações podem incluir nomes de host, FQDNs, endereços IPv4 e endereços IPv6 .
alertsEnabled	booleano	`true` se esse processo do MongoDB tiver alertas habilitados.
authMechanismName	string	mecanismo de autenticação usado para se conectar a esse processo do MongoDB. Isso exibe apenas um dos seguintes valores: `MONGODB_CR` (Isto abrange SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
clusterId	string	Identificador único do cluster ao qual pertence o processo MongoDB.
Criado	data	Data em que o Ops Manager criou ou encontrou pela primeira vez esse processo do MongoDB.
groupId	string	Identificador exclusivo do grupo que possui este host.
hasStartupWarlings	booleano	`true` se esse processo do MongoDB tivesse avisos de inicialização.
escondida	booleano	`true` se host for exibido na UI do MongoDB Ops Manager . Os hosts definidos como `true` são omitidos das respostas da API .
ocultadoSecundário	booleano	`true` se esse host for um secundário oculto.
hostEnabled	booleano	`true` se o processo MongoDB estiver habilitado atualmente.
nome do host	string	Nome do host primário, conforme o gerente de operações pode determinar melhor. Pode ser um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 .
id	string	Identificador único.
ipAddress	string	Endereço IPv4 ou IPv6 associado ao `hostname` deste processo do MongoDB. Endereços IPv4 ou IPv6 acessíveis adicionais podem ser exibidos na array `aliases` .
journalingEnabled	booleano	`true` se o registro no diário estiver habilitado para esse processo do MongoDB.
lastDataSizeBytes	número	Tamanho não compactado dos bancos de dados do host no disco em bytes , excluindo índices. `lastDataSizeBytes` não inclui os dados no banco de dados local .
lastIndexSizeBytes	número	Tamanho não compactado dos índices do banco de dados do host no disco em bytes. Esse número não inclui o tamanho do índice do banco de dados local .
lastPing	data	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o último ping para esse processo do MongoDB foi recebido.
lastRestart	data	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando esse processo foi reiniciado pela última vez. Se o processo MongoDB nunca tiver sido reiniciado, o campo `lastRestart` será omitido.
links	array	Array que inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web . No mínimo, uma array `links` contém um link chamado `self`.
logsEnabled	booleano	`true` se o Ops Manager estiver coletando registros para esse processo do MongoDB.
limite baixo	booleano	`true` se o host do processo MongoDB tiver uma configuração de baixo `ulimit` .
Porta	número	Porta na qual o processo do MongoDB escuta.
profilerEnabled	booleano	`true` se o Ops Manager coletar informações de perfil desse processo do MongoDB.
ReplicaSetName	string	Nome do conjunto de réplicas ao qual este processo pertence. Somente presente se este processo fizer parte de um conjunto de réplicas.
replicationStateName	string	Estado atual deste processo MongoDB dentro de um conjunto de réplicas. Somente presente se esse processo fizer parte de um conjunto de réplicas. Consulte Estados do membro do conjunto de réplicas para obter os valores possíveis.
shardName	string	Nome do fragmento ao qual pertence este processo. Presente somente se o processo fizer parte de um cluster fragmentado.
secondaryDelaySecs	número	Número de segundos que os dados deste membro do conjunto de réplicas rastreiam o primário. Se esse valor estiver definido como `0`, o membro não será configurado como um membro atrasado. Para obter detalhes adicionais sobre atrasos secundários, consulte Membros do conjunto de réplicas atrasados
sslEnabled	booleano	`true` se TLS/SSL e estiver ativado para esse processo do MongoDB .
systemInfo	objeto	Objeto que contém informações de RAM e CPU para esse servidor de processos do MongoDB, conforme relatado pelo sistema operacional ou container.
systemInfo.memSizeMB	número	Quantidade de RAM em megabytes.
systemInfo.numCores	número	Número de núcleos de CPU.
typeName	string	Type for this MongoDB process. Os valores possíveis são: `STANDALONE` `REPLICA_PRIMARY` `REPLICA_SECONDARY` `REPLICA_ARBITER` `RECOVERING` `SHARD_MONGOS` `SHARD_CONFIG` `SHARD_STANDALONE` `SHARD_PRIMARY` `SHARD_SECONDARY` `NO_DATA` O tipo para novos hosts adicionados ao Ops Manager será `NO_DATA` até que o monitoramento receba seu primeiro ping.
tempo de atividadeMsec	número	Número de milissegundos desde a última vez que este processo foi reiniciado.
Versão	string	Versão do MongoDB em execução para este processo.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true" \
     --data '
       {
         "hostname": "server1.example.com",
         "port": 27017
       }'

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

1 {
2   "alertsEnabled" : true,
3   "authMechanismName" : "NONE",
4   "created" : "2014-04-22T19:56:50Z",
5   "groupId" : "{PROJECT-ID}",
6   "hasStartupWarnings" : false,
7   "hidden" : false,
8   "hostEnabled" : true,
9   "hostname" : "server1.example.com",
10   "id" : "{HOST-ID}",
11   "journalingEnabled" : false,
12   "links" : [  ],
13   "logsEnabled" : false,
14   "lowUlimit" : false,
15   "port" : 27017,
16   "profilerEnabled" : false,
17   "sslEnabled" : false
18   "systemInfo" : {
19     "memSizeMB" : 65536,
20     "numCores" : 16
21   },
22 }

Voltar

Obter um host por nome de host e porta

Atualizar a configuração de um host monitorado

1	{
2	"alertsEnabled" : true,
3	"authMechanismName" : "NONE",
4	"created" : "2014-04-22T19:56:50Z",
5	"groupId" : "{PROJECT-ID}",
6	"hasStartupWarnings" : false,
7	"hidden" : false,
8	"hostEnabled" : true,
9	"hostname" : "server1.example.com",
10	"id" : "{HOST-ID}",
11	"journalingEnabled" : false,
12	"links" : [ ],
13	"logsEnabled" : false,
14	"lowUlimit" : false,
15	"port" : 27017,
16	"profilerEnabled" : false,
17	"sslEnabled" : false
18	"systemInfo" : {
19	"memSizeMB" : 65536,
20	"numCores" : 16
21	},
22	}