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

Raiz

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

O recurso raiz é o ponto de partida da API do Ops Manager. A partir daqui, você pode percorrer o links para acessar todos os outros recursos da API.

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

Resource

GET /

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
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 results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false
backupJobsEnabledOnly
booleano
Opcional
Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.
true

Parâmetros do corpo da solicitação

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

Resposta

A resposta inclui:

Nome
Tipo
Descrição
appName
string
MongoDB Ops Manager
COMPILAR
string
O SHA que corresponde ao commit do Github para o Ops Manager.
links
array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

estrangulamento
booleano
O campo está obsoleto e tem o valor false .

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "<ops-manager-host>:<port>/api/public/v1.0"

Exemplo de resposta

{
   "appName" : "MongoDB Ops Manager",
   "build" : "ec8b09b880be314981caa9d8fbefc3280056522e",
   "links" : [
   ],
   "throttling" : false
}

Voltar

Recursos da API de administração do Ops Manager