Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Implantações
/
Anfitriões

Obter todos os hosts em um projeto

Nesta página

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

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.

Obtenha todos os hosts do MongoDB em um projeto. Utilize o query CLUSTER-ID para obter somente os hosts que pertencem ao cluster especificado. A resposta classifica os hosts alfabeticamente por HOSTNAME:PORT.

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

Resource

GET /groups/{PROJECT-ID}/hosts
GET /groups/{PROJECT-ID}/hosts?clusterId={CLUSTER-ID}

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 host MongoDB.

Solicitar parâmetros de query

Nome
Tipo
necessidade
Descrição
Default

pageNum

número

Opcional

Um inteiro baseado que retorna uma subseção de resultados.

1

itemsPerPage

número

Opcional

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Opcional

Sinalizador que indica 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 do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure envelope : true na consulta.

Para endpoints que retornam uma lista de resultados, o objeto content é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false

Parâmetro
Tipo
necessidade
Descrição

ID DE CLUSTER

string

Obrigatório

Identificador único do cluster ao qual pertence este processo MongoDB.

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado .

links

array

A array 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.

totalCount

número

Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada resultado é um host.

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.

Observação

Alguns hosts não retornam clusterId. Isso ocorre quando um processo mongos roteia as operações de dados para shards que não armazenam dados. O MongoDB Ops Manager não atribui um clusterId a alguns nós que não contêm dados.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true"

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 200 OK
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  "totalCount" : 2,
3  "results" : [
4    {
5      "alertsEnabled" : true,
6      "aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ],
7      "authMechanismName" : "SCRAM-SHA-1",
8      "clusterId" : "{CLUSTER-ID}",
9      "created" : "2024-04-22T19:56:50Z",
10      "groupId" : "{PROJECT-ID}",
11      "hasStartupWarnings" : false,
12      "hidden" : false,
13      "hostEnabled" : true,
14      "hostname" : "{HOSTNAME}",
15      "id" : "{HOST-ID}",
16      "ipAddress": "127.0.0.1",
17      "journalingEnabled" : false,
18      "lastDataSizeBytes" : 633208918,
19      "lastIndexSizeBytes" : 101420524,
20      "lastPing" : "2024-08-18T11:23:41Z",
21      "links" : [  ],
22      "logsEnabled" : false,
23      "lowUlimit" : false,
24      "muninEnabled" : false,
25      "port" : 26000,
26      "profilerEnabled" : false,
27      "replicaSetName": "rs1",
28      "replicaStateName" : "PRIMARY",
29      "sslEnabled" : true,
30      "systemInfo" : {
31        "memSizeMB" : 65536,
32        "numCores" : 16
33      },
34      "typeName": "REPLICA_PRIMARY",
35      "uptimeMsec": 1827300394,
36      "username" : "mongo",
37      "version" : "4.4.0"
38    },
39    {
40
41    }
42  ]
43}

Observação

Embora o gerentede operações 4 do MongoDB retorne muninEnabled na resposta, MongoDB não é suportado a partir do MongoDB Ops Manager .4.

Voltar

Anfitriões

Próximo

Obter por ID