Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Uso do servidor MongoDB

Recuperar todos os hosts físicos

Nesta página

  • Funções obrigatórias
  • 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

Funções obrigatórias

Esse recurso exige que achave de API tenha a função Global Owner .

Resource

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

GET /usage/groups

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

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

Nome
Tipo
Descrição
Default
pageNum
inteiro
Número da página (com base em índice 1).
1
itemsPerPage
inteiro
Número de itens a serem devolvidos por página, até um máximo de 500.
100
pretty
booleano
Indica se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
booleano

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 um resultado, o corpo da resposta inclui:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado

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

none

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 Documento incorporadoresults .
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 elemento na array de resultados é um host físico.

Elemento de resposta
Tipo
Descrição
hosts
Array de objetos
Lista de hosts virtuais vinculados ao host físico fornecido.
hosts
.[n].groupId
string
Identificador único do projeto no qual o Ops Manager coloca esse host virtual.
hosts
.[n].hostname
string
FQDN do host virtual vinculado ao host físico.
id
string
Identificador único do host físico ao qual o Ops Manager vinculou os hosts virtuais.
name
string
Etiqueta que você deu ao host físico.
serverType
string

Tipo de servidor do host físico.

O Ops Manager retorna um dos seguintes valores:

  • DEV_SERVER

  • TEST_SERVER

  • production_server

  • RAM_POOL

Para saber mais, consulte Uso do MongoDB .

Exemplo de solicitação

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?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  "links": [
3    {
4      "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100",
5      "rel": "self"
6    }
7  ],
8  "results": [
9    {
10      "hosts": [
11        {
12          "groupId": "{projectId1}",
13          "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7"
14        },
15        {
16          "groupId": "{projectId1}",
17          "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8"
18        }
19      ],
20      "id": "{physicalHostId1}",
21      "name": "physicalHostA",
22      "serverType": "DEV_SERVER"
23    },
24    {
25      "hosts": [
26        {
27          "groupId": "{projectId2}",
28          "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0"
29        },
30        {
31          "groupId": "{projectId2}",
32          "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
33        }
34      ],
35      "id": "{physicalHostId2}",
36      "name": "physicalHostB",
37      "serverType": "DEV_SERVER"
38    },
39  ],
40  "totalCount": 2
41}

Voltar

Gerar snapshot de uso diário

Próximo

Recuperar um host físico