Reconhecer um 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
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 .

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.

Resource

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

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

Parâmetros do caminho da solicitação

Parâmetro	Tipo	necessidade	Descrição
`PROJECT-ID`	string	Obrigatório	Identificador único do projeto em que este alerta está definido.
`ALERT-ID`	string	Obrigatório	Identificador único para o alerta.

Solicitar parâmetros de query

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

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador indicando 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 da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

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

false

Parâmetros do corpo da solicitação

Campo	Tipo	necessidade	Descrição
`acknowledged` `Until`	string	Condicional	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC até o qual o alerta deve ser confirmado. Para confirmar um alerta "para sempre", defina o valor do campo como um grande número de anos no futuro. Recomendamos definir 100 anos no futuro. Para cancelar a confirmação de um alerta confirmado, remova este parâmetro da sua solicitação.
`acknowledgement` `Comment`	string	Opcional	Descrição de texto do motivo desse reconhecimento. Cloud Manager exibe o comentário ao lado da mensagem de que o alerta foi confirmado.

Resposta

Os campos no documento de devolução dependem do tipo de alerta:

Nome	Tipo	Descrição
`acknowledged` `Until`	string	Carimbo de data/hora na ISO 8601 formato de data e hora no UTC até o qual o alerta foi confirmado. O Cloud Manager retorna esse valor se o alerta tiver sido confirmado.
`acknowledgement` `Comment`	string	Comentário deixado pelo usuário que reconheceu o alerta. O Cloud Manager retorna esse valor se o alerta tiver sido confirmado.
`acknowledging` `Username`	string	Nome de usuário do usuário que reconheceu o alerta. O Cloud Manager retorna esse valor se o alerta tiver sido confirmado.
`alertConfigId`	string	Identificador exclusivo para a configuração de alerta que acionou este alerta.
`clusterId`	string	Identificador único do cluster ao qual este alerta se aplica. Cloud Manager retorna esse valor se `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Nome do cluster ao qual este alerta se aplica. Cloud Manager retorna esse valor se `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	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. O Cloud Manager retorna esse valor se `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
`currentValue` `.number`	número	Valor da métrica.
`currentValue` `.units`	string	Unidades para o valor. 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. O Cloud Manager pode retornar: `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 aceitos são: Agente `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` Configuração da automação `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup. `BAD_CLUSTERSHOTS` `CLUSTER_BLACKLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_BLACKLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` BI Connector `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` Cobrança `ACCOUNT_DOWNGRADED` `ACCOUNT_UPGRADED` `CHARGE_FAILED` `CHARGE_SUCCEEDED` `CHECK_PAYMENT_RECEIVED` `CREDIT_CARD_ABOUT_TO_EXPIRE` `CREDIT_CARD_CURRENT` `CREDIT_ISSUED` `DAILY_BILL_OVER_THRESHOLD` `DAILY_BILL_UNDER_THRESHOLD` `DISCOUNT_APPLIED` `INVOICE_ADDRESS_ADDED` `INVOICE_ADDRESS_CHANGED` `INVOICE_CLOSED` `PAYMENT_FORGIVEN` `PENDING_INVOICE_OVER_THRESHOLD` `PENDING_INVOICE_UNDER_THRESHOLD` `PREPAID_PLAN_ACTIVATED` `PROMO_CODE_APPLIED` `REFUND_ISSUED` `STALE_PENDING_INVOICES` `WIRE_TRANSFER_PAYMENT_RECEIVED` cluster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Data Explorer acessado `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Backup em disco `CPS_RESTORE_REQUESTED_AUDIT` Anfitrião `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_EXPOSED` `HOST_IP_CHANGED_AUDIT` `HOST_LOCKED_DOWN` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` Organização `ALL_ORG_USERS_HAVE_MFA` `ORG_ACTIVATED` `ORG_ADMIN_SUSPENDED` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` `ORG_CREDIT_CARD_ADDED` `ORG_CREDIT_CARD_CURRENT` `ORG_CREDIT_CARD_UPDATED` `ORG_DAILY_BILL_OVER_THRESHOLD` `ORG_DAILY_BILL_UNDER_THRESHOLD` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_GROUP_CHARGES_OVER_THRESHOLD` `ORG_GROUP_CHARGES_UNDER_THRESHOLD` `ORG_INVOICE_OVER_THRESHOLD` `ORG_INVOICE_UNDER_THRESHOLD` `ORG_LOCKED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_SUSPENDED` `ORG_TEMPORARILY_ACTIVATED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Projeto `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `DELINQUENT` `PAID_IN_FULL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Conjunto de réplicas `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` Caso de suporte `CASE_CREATED` team `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` Usuário `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP`
`groupId`	string	Identificador único do grupo para o qual este alerta foi aberto.
`hostId`	string	identificador exclusivo do host ao qual a métrica pertence. Cloud Manager retornará este valor se `"eventTypeName"` foi definido para um dos seguintes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	string	Nome do host e porta de cada host ao qual o alerta se aplica. Pode ser um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6 . Cloud Manager retornará este valor se `"eventTypeName"` foi definido para um dos seguintes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `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. O Cloud Manager retorna esse valor se notificações tiverem sido enviadas.
`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.
`metricName`	string	Nome da medição cujo valor ficou fora do limite. Cloud Manager retornará esse valor se `"eventTypeName"` tiver sido definido como `OUTSIDE_METRIC_THRESHOLD`. Para obter valores possíveis, consulte Tipos de medição para alertas.
`replicaSetName`	string	Nome do conjunto de réplicas. Cloud Manager retornará este valor se `"eventTypeName"` foi definido para um dos seguintes: `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi fechado. O Cloud Manager retorna esse valor se `"status" : "CLOSED"`.
`status`	string	Estado atual do alerta. O Cloud Manager pode retornar um dos seguintes: `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`
`sourceTypeName`	string	Tipo de host que está sendo copiado quando `"eventTypeName" : "BACKUP"`. O Cloud Manager pode retornar um dos seguintes: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	array de strings	Identificar rótulos definidos para este alerta.
`typeName`	string	Campo obsoleto. \|mms\| ignora.
`updated`	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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6      --data '
7        {
8          "acknowledgedUntil": "2016-04-15T00:00:00-0400",
9          "acknowledgementComment": "This is normal. Please ignore."
10        }'

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   "id" : "{ALERT-CONFIG-ID}",
3   "groupId" : "{PROJECT-ID}",
4   "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5   "status" : "OPEN",
6   "acknowledgedUntil" : "2014-04-15T04:00:00Z",
7   "acknowledgementComment" : "This is normal. Please ignore.",
8   "acknowledgingUsername" : "someuser@example.com",
9   "created" : "2014-04-03T20:28:14Z",
10   "updated" : "2014-04-03T20:33:14Z",
11   "lastNotified" : "2014-04-03T20:33:23Z",
12   "metricName": "ASSERTS_REGULAR",
13   "currentValue" : {
14     "number" : 0.0,
15     "units" : "RAW"
16   },
17   "links" : []
18 }

Voltar

Obter um alerta

Configurações de alerta

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6	--data '
7	{
8	"acknowledgedUntil": "2016-04-15T00:00:00-0400",
9	"acknowledgementComment": "This is normal. Please ignore."
10	}'

1	{
2	"id" : "{ALERT-CONFIG-ID}",
3	"groupId" : "{PROJECT-ID}",
4	"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5	"status" : "OPEN",
6	"acknowledgedUntil" : "2014-04-15T04:00:00Z",
7	"acknowledgementComment" : "This is normal. Please ignore.",
8	"acknowledgingUsername" : "someuser@example.com",
9	"created" : "2014-04-03T20:28:14Z",
10	"updated" : "2014-04-03T20:33:14Z",
11	"lastNotified" : "2014-04-03T20:33:23Z",
12	"metricName": "ASSERTS_REGULAR",
13	"currentValue" : {
14	"number" : 0.0,
15	"units" : "RAW"
16	},
17	"links" : []
18	}