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 termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}Parâmetros do caminho da solicitação
Parâmetro | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Obrigatório | Identificador único do projeto em que este alerta está definido. |
| 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 que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve envolver a resposta em um 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 query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Campo | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Condicional | Carimbo de data/hora no formato ISO 8601 de data e hora em UTC até o qual o alerta deve ser reconhecido.
|
| string | Opcional | Descrição de texto do motivo desse reconhecimento. O Ops 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 |
|---|---|---|
| string | Carimbo de data/hora no formato ISO 8601 em UTC até o qual o alerta foi reconhecido. O Ops Manager retorna esse valor se o alerta tiver sido confirmado. |
| string | Comentário deixado pelo usuário que reconheceu o alerta. O Ops Manager retorna esse valor se o alerta tiver sido confirmado. |
| string | Nome de usuário do usuário que reconheceu o alerta. O Ops Manager retorna esse valor se o alerta tiver sido confirmado. |
| string | Identificador exclusivo para a configuração de alerta que acionou este alerta. |
| string | Identificador único do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se |
| string | Nome do cluster ao qual este alerta se aplica. O Ops Manager retorna esse valor se |
| string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi aberto. |
| objeto | Valor atual da métrica que acionou o alerta. O Ops Manager retorna esse valor se |
| número | Valor da métrica. |
| 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 Ops Manager pode retornar:
|
| string | Nome do evento que acionou o alerta. Os valores aceitos são: Agente Configuração da automação Backup. BI Connector cluster Data Explorer acessado Anfitrião Organização Projeto Conjunto de réplicas team Usuário Para obter uma lista completa de eventos incluÃdos no registro de auditoria do Ops Manager, consulte Eventos de auditoria. |
| string | Identificador único do grupo para o qual este alerta foi aberto. |
| string | identificador exclusivo do host ao qual a métrica pertence. O Ops Manager retorna este valor se
|
| string | Nome do host e porta de cada hospedar ao qual o alerta se aplica. Isso pode ser um nome de host, um FQDN, um endereço IPv4 ou um endereço IPv6. O Ops Manager retorna este valor se
|
| string | Identificador único para o alerta. |
| string | Carimbo de data/hora no formato de data e hora ISO 8601 em UTC quando a última notificação foi enviada para este alerta. O MongoDB Ops Manager retorna esse valor se as notificações tiverem sido enviadas. |
| Array de objetos | Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays |
| string | Nome da medição cujo valor ficou fora do limite. O Ops Manager retorna esse valor se Para obter valores possÃveis, consulte Tipos de medição para alertas. |
| string | Nome do conjunto de réplicas. O Ops Manager retorna este valor se
|
| string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o alerta foi encerrado. O Ops Manager retorna esse valor se |
| string | Estado atual do alerta. O Ops Manager pode retornar um dos seguintes:
|
| string | Tipo de host que está sendo copiado quando
|
| array de strings | Identificar rótulos definidos para este alerta. |
| string | Carimbo de data/hora no formato de data e hora ISO 8601 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" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}" --data ' { "acknowledgedUntil": "2016-04-15T00:00:00-0400", "acknowledgementComment": "This is normal. Please ignore." }'Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "id" : "{ALERT-CONFIG-ID}", "groupId" : "{PROJECT-ID}", "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "status" : "OPEN", "acknowledgedUntil" : "2014-04-15T04:00:00Z", "acknowledgementComment" : "This is normal. Please ignore.", "acknowledgingUsername" : "someuser@example.com", "created" : "2014-04-03T20:28:14Z", "updated" : "2014-04-03T20:33:14Z", "lastNotified" : "2014-04-03T20:33:23Z", "metricName": "ASSERTS_REGULAR", "currentValue" : { "number" : 0.0, "units" : "RAW" }, "links" : []}