Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Medições e alertas
/
Configurações de alerta

Obter alertas abertos para configuração de alerta

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.

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

Resource

GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts

Parâmetros do caminho da solicitação

Todos os parâmetros do caminho da solicitação são obrigatórios.

Parâmetro
Tipo
Descrição

ID do projeto

string

Identificador único para este projeto.

alerta-CONFIG-ID

string

Identificador exclusivo para esta configuração de alerta.

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

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 é uma configuração de alerta.

Observação

Os detalhes do alerta variam. Um alerta pode incluir apenas um subconjunto desses elementos.

Nome
Tipo
Descrição

acknowledgedUntil

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi confirmado. Preenchido se o alerta tiver sido reconhecido.

acknowledgedUsername

string

Nome de usuário do usuário que reconheceu o alerta. Preenchido se o alerta tiver sido reconhecido.

acknowledgementComment

string

Usuário de comentário que reconheceu o alerta deixado. Preenchido se o alerta tiver sido reconhecido.

alertConfigId

string

Identificador exclusivo da configuração de alerta que acionou esse alerta.

clusterId

string

Identificador único do cluster ao qual este alerta se aplica. Preenchido para alertas BACKUP, REPLICA_SET e CLUSTER .

clusterName

string

Dê um nome ao cluster ao qual esse alerta se aplica. Preenchido para alertas BACKUP, REPLICA_SET e CLUSTER .

Criado

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi aberto.

currentValue

objeto

Valor atual da métrica que acionou o alerta. Preenchido para alertas de HOST_METRIC .

currentValue.number

número

Valor da métrica.

currentValue.units

string

Unidades para o valor. Depende do tipo de métrica.

Por exemplo, uma métrica que mede o consumo de memória teria uma medida de bytes, enquanto uma métrica que mede o tempo teria uma unidade de tempo. Os valores aceitos são:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName

string

Nome do evento que acionou o alerta.

Os valores incluem:

Agente

Configuração da automação

Backup.

BI Connector

Cobrança

cluster

Data Explorer acessado

Backup em disco

Anfitrião

Organização

Projeto

Conjunto de réplicas

Caso de suporte

team

Usuário

Para ver a lista completa de eventos que geram alertas e suas descrições, consulte Tipos de alerta.

groupId

string

Identificador único do projeto para o qual este alerta foi aberto.

hostId

string

Identificador único do host ao qual a métrica pertence. Preenchido para alertas HOST, HOST_METRIC e REPLICA_SET .

Nome de host e porta

string

Nome do host e porta de cada host ao qual o alerta se aplica. Preenchido para alertas HOST, HOST_METRIC e REPLICA_SET .

id

string

Identificador único para o alerta.

lastNotified

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a última notificação foi enviada para este alerta. Preenchido se as notificações tiverem sido enviadas.

metricName

string

Nome da medição cujo valor ficou fora do limite. Preenchido se "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Para obter os valores aceitos, consulte Tipos de medição para alertas nesta página.

ReplicaSetName

string

Nome do conjunto de réplicas. Preenchido para alertas HOST, HOST_METRIC, BACKUP e REPLICA_SET .

resolvido

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi fechado. Preenchido se "status" : "CLOSED".

sourceTypeName

string

Para alertas do BACKUP , o tipo de servidor que está sendo copiado. Os valores aceitos são:

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

Status

string

Estado atual do alerta. Os valores aceitos são:

  • TRACKING

    A condição de alerta existe, mas não persistiu além do atraso de notificação definido. Para obter detalhes, consulte Solicitar parâmetros de query.

  • OPEN

  • CLOSED

  • CANCELLED

typeName

string

Este campo é preterido e será ignorado.

Atualizado

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi atualizado pela última vez.

Exemplo de solicitação

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}/alertConfigs/{ALERT-CONFIG-ID}/alerts"

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" : [ {
    "acknowledgedUntil" : "2014-05-01T14:00:00Z",
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T15:57:13.562Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "53569159300495c7702ee3a3",
    "lastNotified" : "2014-04-22T15:57:24.126Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  }, {
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T19:59:10.657Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "5356ca0e300495c770333340",
    "lastNotified" : "2014-04-22T20:14:19.313Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  } ],
  "totalCount" : 2
}

Voltar

Excluir

Próximo

Eventos