Obtenha agentes por tipo para 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
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

Obter todos os agentes de um tipo especificado (ou seja, monitoramento, backup ou automação) para um projeto.

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.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/agents/{TYPE}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	Identificador exclusivo do projeto que possui a chave de API do agente.
Tipo	string	O tipo de agente a ser recuperado. O type pode ser um dos seguintes valores: `MONITORING` `BACKUP` `AUTOMATION`

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 `content` é um envelope. O Cloud 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

Nome	Tipo	Descrição
`typeName`	string	O tipo de agente: `MONITORING`, `BACKUP` ou `AUTOMATION`.
`hostname`	string	Nome de host primário. Um host normalmente pode ter aliases, então o principal é o melhor nome disponível conforme determinado pelo Cloud Manager.
`confCount`	número	Número de chamadas de configuração.
`lastConf`	timestamp	Data e hora da última chamada de configuração.
`stateName`	string	O estado atual do agente. `stateName` pode retornar os seguintes valores: `ACTIVE`: o agente está ativo e operando `STANDBY`: o agente está em espera `NO_PROCESSES`: o agente não está gerenciando, monitorando ou fazendo backup de nenhum processo.
`pingCount`	número	Aplicável apenas ao agente de monitoramento. O número de pings que o agente de monitoramento enviou para a URL `hostname` .
`isManaged`	Boolean	Aplicável apenas a agente de monitoramento e agente de backup. Especifica se o Cloud Manager gerencia ou não o agente.
`lastPing`	timestamp	Aplicável apenas ao agente de monitoramento. Hora do ping mais recente.
`tag`	string	Aplicável apenas a agente de backup. A marcação do agente, se houver uma.

Exemplo de solicitação

Obtenha todos os agentes de monitoramento para um projeto.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING"

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

{
  "links" : [],
  "results": [
    {
      "confCount": 59,
      "hostname": "example",
      "isManaged": true,
      "lastConf": "2015-06-18T14:21:42Z",
      "lastPing": "2015-06-18T14:21:42Z",
      "pingCount": 6,
      "stateName": "ACTIVE",
      "typeName": "MONITORING"
    }
  ],
  "totalCount": 1
}

Voltar

Obter links

Criar chave API