Retornar todos os alertas abertos para uma configuração de alerta

OBTER /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}/alerts
Contas de serviço DigestAuth

Retorna todos os alertas abertos que a configuração de alerta especificada aciona. Essas configurações de alerta se aplicam somente ao projeto especificado. As configurações de alerta definem os acionadores e os métodos de notificação para alertas. Alertas abertos foram acionados, mas permanecem não reconhecidos. Use o ponto de extremidade Retornar todas as configurações de alerta para um projeto para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.

Este recurso permanece sob revisão e pode mudar.

Requisitos de função
  • Somente leitura do projeto
Retornar todas as configurações de alerta...

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • alertConfigId string Obrigatório

    String exclusiva de 24 dígitos hexadecimais que identifica a configuração do alerta.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • incluir contagem booleano

    Sinalizador que indica se o MongoDB nuvem calcula o número total de itens para a resposta. Quando definido como false, a nuvem MongoDB pode ignorar uma operação de contagem adicional. A resposta ainda pode incluir totalCount quando a contagem estiver disponível sem cálculo adicional.

    O valor padrão é true.

  • itemsPerPage inteiro

    Número de itens que a resposta retorna por página.

    O valor mínimo é 1, o valor máximo é 500. O valor padrão é 100.

  • pageNum inteiro

    Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

    O valor mínimo é 1. O valor padrão é 1.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • links array[objeto]

      Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

      Especificação de links da web (RFC...
      Ocultar atributos dos links Mostrar atributos dos links objeto
      • href string

        Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

      • rel string

        Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

    • Resultados array[objeto] Obrigatório

      Lista de documentos retornados que o MongoDB Cloud fornece ao concluir esta solicitação.

      Um dos seguintes:
      Alertas do aplicativo Services objeto objeto de Alertas de Cluster Alertas do hospedar objeto objeto Alertas de métricas flexíveis objeto HostMetricAlert objeto Alertas do ReplicaSet objeto de Alertas do Processador de Stream Qualquer outro objeto de alerta
    • contagem total integer(int32)

      Número total de documentos disponíveis. Quando includeCount é definido como false, o MongoDB nuvem pode omitir esse valor ou retorná-lo quando a contagem estiver disponível sem cálculos adicionais. O número total é uma estimativa e pode não ser exato.

      O valor mínimo é 0.
  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe corda | zero

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • políticasCausingDecision array[objeto]

      Políticas de recursos do Atlas que fizeram com que a solicitação fosse negada. Retornado somente quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.

      Não mais do que 100 elementos.

      Ocultar atributos das políticas CausingDecision Mostrar atributos das políticas CausingDecision objeto

      Política de Recursos do Atlas que fez com que a solicitação fosse negada.

      • id string Obrigatório

        String exclusiva 24-hexadecimal que identifica a Política de Recursos do Atlas .

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • name string Obrigatório

        Etiqueta legível por humanos que identifica a Política de Recursos do Atlas .

    • Razão corda | zero

      Mensagens de erro de aplicativo retornadas com este erro.
  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe corda | zero

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • políticasCausingDecision array[objeto]

      Políticas de recursos do Atlas que fizeram com que a solicitação fosse negada. Retornado somente quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.

      Não mais do que 100 elementos.

      Ocultar atributos das políticas CausingDecision Mostrar atributos das políticas CausingDecision objeto

      Política de Recursos do Atlas que fez com que a solicitação fosse negada.

      • id string Obrigatório

        String exclusiva 24-hexadecimal que identifica a Política de Recursos do Atlas .

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • name string Obrigatório

        Etiqueta legível por humanos que identifica a Política de Recursos do Atlas .

    • Razão corda | zero

      Mensagens de erro de aplicativo retornadas com este erro.
  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe corda | zero

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • políticasCausingDecision array[objeto]

      Políticas de recursos do Atlas que fizeram com que a solicitação fosse negada. Retornado somente quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.

      Não mais do que 100 elementos.

      Ocultar atributos das políticas CausingDecision Mostrar atributos das políticas CausingDecision objeto

      Política de Recursos do Atlas que fez com que a solicitação fosse negada.

      • id string Obrigatório

        String exclusiva 24-hexadecimal que identifica a Política de Recursos do Atlas .

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • name string Obrigatório

        Etiqueta legível por humanos que identifica a Política de Recursos do Atlas .

    • Razão corda | zero

      Mensagens de erro de aplicativo retornadas com este erro.
  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe corda | zero

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • políticasCausingDecision array[objeto]

      Políticas de recursos do Atlas que fizeram com que a solicitação fosse negada. Retornado somente quando errorCode é ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED.

      Não mais do que 100 elementos.

      Ocultar atributos das políticas CausingDecision Mostrar atributos das políticas CausingDecision objeto

      Política de Recursos do Atlas que fez com que a solicitação fosse negada.

      • id string Obrigatório

        String exclusiva 24-hexadecimal que identifica a Política de Recursos do Atlas .

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • name string Obrigatório

        Etiqueta legível por humanos que identifica a Política de Recursos do Atlas .

    • Razão corda | zero

      Mensagens de erro de aplicativo retornadas com este erro.
GET /API/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}/alerts 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/alertConfigs/32b6e34b3d91647abb20e7b8/alerts' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "acknowledgedUntil": "2026-05-04T09:42:00Z",
      "acknowledgementComment": "Expiration on 3/19.  Silencing for 7 days.",
      "acknowledgingUsername": "hello@example.com",
      "alertConfigId": "32b6e34b3d91647abb20e7b8",
      "created": "2026-05-04T09:42:00Z",
      "eventTypeName": "DEPLOYMENT_FAILURE",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "lastNotified": "2026-05-04T09:42:00Z",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "orgId": "32b6e34b3d91647abb20e7b8",
      "resolved": "2026-05-04T09:42:00Z",
      "severity": "INFO",
      "status": "OPEN",
      "updated": "2026-05-04T09:42:00Z"
    }
  ],
  "totalCount": 42
}
Exemplos de resposta (401) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Exemplos de resposta (403) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Exemplos de resposta (404) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Exemplos de resposta (500) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}