Obter um host por nome de host e porta
Nesta página
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 um único processo MongoDB pela combinação de nome de host e porta. Você pode especificar o nome do host primário ou um alias.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/byName/{HOSTNAME}:{PORT}
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. |
Nome do host | string | Obrigatório | O nome de host principal que o Ops Manager deve usar para se conectar a esta instância do MongoDB. Esse nome de host pode ser um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 . |
Porta | string | Obrigatório | Porta na qual o processo do MongoDB escuta. |
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. |
| ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de 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:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
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 |
|
authMechanismName | string | mecanismo de autenticação usado para se conectar a esse processo do MongoDB. Isso exibe apenas um dos seguintes valores:
|
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 |
|
escondida | booleano |
|
ocultadoSecundário | booleano |
|
hostEnabled | booleano |
|
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 |
journalingEnabled | booleano |
|
lastDataSizeBytes | número | Tamanho não compactado dos bancos de dados do host no disco em bytes , excluindo índices. |
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 |
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 |
logsEnabled | booleano |
|
limite baixo | booleano |
|
Porta | número | Porta na qual o processo do MongoDB escuta. |
profilerEnabled | booleano |
|
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 |
sslEnabled | booleano |
|
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:
O tipo para novos hosts adicionados ao Ops Manager será |
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" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/byName/server1.example.com:27017?pretty=true"
Exemplo de resposta
Cabeçalho de resposta
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
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 "alertsEnabled" : true, 3 "aliases": [ "server1.example.com:27017", "10.1.0.10:27017" ], 4 "authMechanismName" : "SCRAM-SHA-1", 5 "clusterId" : "{CLUSTER-ID}", 6 "created" : "2024-04-22T19:56:50Z", 7 "groupId" : "{PROJECT-ID}", 8 "hasStartupWarnings" : false, 9 "hidden" : false, 10 "hostEnabled" : true, 11 "hostname" : "server1.example.com", 12 "id" : "{HOST-ID}", 13 "ipAddress": "10.1.0.10", 14 "journalingEnabled" : false, 15 "lastDataSizeBytes" : 633208918, 16 "lastIndexSizeBytes" : 101420524, 17 "lastPing" : "2024-08-18T11:23:41Z", 18 "links" : [ ], 19 "logsEnabled" : false, 20 "lowUlimit" : false, 21 "muninEnabled" : false, 22 "port" : 27017, 23 "profilerEnabled" : false, 24 "replicaSetName": "rs1", 25 "replicaStateName" : "PRIMARY", 26 "sslEnabled" : true, 27 "systemInfo" : { 28 "memSizeMB" : 65536, 29 "numCores" : 16 30 }, 31 "typeName": "REPLICA_PRIMARY", 32 "uptimeMsec": 1827300394, 33 "username" : "mongodb", 34 "version" : "4.4.0" 35 }
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.