/ /

Gerente de Operaciones

Obtener todas las alertas globales

Retrieve all global alerts.

Roles necesarios

Puede llamar correctamente a este punto final con cualquiera de los siguientes roles asignados:

Solicitud

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /globalAlerts

Parámetros de la ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure `envelope : true` en la consulta. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

status

string

Opcional

Estado de las alertas que desea devolver. Ops Manager devuelve alertas que coinciden con el estado indicado. Los valores aceptados incluyen:

`TRACKING`	Existen condiciones de alerta, pero la condición no ha persistido el tiempo suficiente para activar una alerta.
`OPEN`	La alerta está abierta.
`CLOSED`	La alerta está cerrada.

Ninguno

createdOnOrAfter

campo de fecha

Opcional

Fecha de creación de las alertas que desea devolver. Ops Manager devuelve las alertas creadas a partir de la fecha indicada.

Ninguno

createdOnOrBefore

campo de fecha

Opcional

Fecha de creación de las alertas que desea devolver. Ops Manager devuelve las alertas creadas en la fecha indicada o antes.

Ninguno

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	arreglo	El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

Cada resultado es una alerta.

Nombre

Tipo

Descripción

acknowledgedUntil

string

Sello de tiempo en ISO 8601 formato de fecha y hora en UTC mediante el cual se ha confirmado la alerta. Ops Manager muestra este campo si un usuario reconoció esta alerta.

acknowledgementComment

string

Comentario que el usuario que reconoció esta alerta dejó. Ops Manager presenta este campo si un usuario reconoció esta alerta.

acknowledgingUsername

string

Nombre de usuario de Ops Manager del usuario que acusó recibo de la alerta. Ops Manager presenta este campo si un usuario reconoce esta alerta.

alertConfigId

string

Identificador único de la configuración global de alertas que activó esta alerta.

clusterId

string

Identificador único del clúster al que se aplica esta alerta. Ops Manager devuelve este campo para alertas globales en las siguientes categorías:

clusterName

string

Nombre el clúster al que se aplica esta alerta. Ops Manager devuelve este campo para las alertas globales en las categorías:

created

string

Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando se creó la alerta.

currentValue

Objeto

Valor actual de la métrica que activó la alerta. Ops Manager devuelve este campo para las alertas globales de la categoría de host.

currentValue.number

Número

Valor actual de la métrica.

currentValue.units

string

Unidades para currentValue.number. Las unidades dependen del tipo de métrica.

Los valores aceptados son:

RAW
BITS
BYTES
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
GIGABITS
GIGABYTES
TERABYTES
PETABYTES
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Por ejemplo, una métrica que mide el consumo de memoria puede usar BYTES, mientras que una métrica que mide el tiempo puede usar HOURS.

eventTypeName

string

Nombre del evento que activó la alerta.

Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas.

Para obtener una lista completa de los eventos incluidos en el registro de auditoría del Ops Manager, consulte Eventos de Auditoría.

groupId

string

Identificador único del proyecto para el cual se abrió esta alerta.

hostId

string

Identificador único del host al que corresponde la métrica. Ops Manager devuelve este campo para alertas globales en las siguientes categorías:

hostnameAndPort

string

Nombre de host y puerto de cada host al que se aplica la alerta. El nombre de host solo puede ser un nombre de host, un FQDN, una dirección IPv4 o una dirección IPv6. Ops Manager devuelve este campo para las alertas globales en las siguientes categorías:

id

string

Identificador único de la alerta.

lastNotified

string

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando se envió la última notificación para esta alerta. Ops Manager muestra esto si Ops Manager envía notificaciones.

metricName

string

Nombre de la medida cuyo valor superó el umbral. Ops Manager devuelve este campo si "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Para posibles valores, consulta Tipos de mediciones para alertas globales.

replicaSetName

string

Nombre del set de réplicas. Ops Manager devuelve este campo para alertas globales en las categorías de:

resolved

string

Timestamp en ISO 8601 formato de fecha y hora en UTC cuando se cerró la alerta. Ops Manager devuelve este campo para alertas globales cuando "status" : "CLOSED".

sourceTypeName

string

Tipo de host que se está respaldando. Ops Manager devuelve este campo para alertas globales en la categoría de copia de seguridad. Los valores posibles que se pueden devolver incluyen:

REPLICA_SET
SHARDED_CLUSTER
CONFIG_SERVER

status

string

Estado actual de la alerta. Los valores posibles que se pueden devolver incluyen:

`TRACKING`	Existen condiciones de alerta, pero la condición no ha persistido el tiempo suficiente para activar una alerta.
`OPEN`	La alerta está abierta.
`CLOSED`	La alerta está cerrada.
`CANCELLED`	Se cancela la alerta.

tags

Arreglo de cadenas

Etiquetas asociadas a esta alerta.

typeName

string

Este campo está obsoleto y será ignorado.

updated

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando esta alerta fue actualizada por última vez.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts"

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

1 {
2   "links": [],
3   "results": [{
4       "alertConfigId": "{ALERT-CONFIG-ID}",
5       "created": "2019-11-29T20:26:30Z",
6       "eventTypeName": "BACKUP_AGENT_DOWN",
7       "groupId": "{PROJECT-ID}",
8       "id": "{ALERT-ID}",
9       "lastNotified": "2020-04-09T20:21:00Z",
10       "links": [],
11       "status": "OPEN",
12       "tags": [],
13       "typeName": "AGENT",
14       "updated": "2019-11-29T20:26:30Z"
15     },
16     {
17       "alertConfigId": "{ALERT-CONFIG-ID}",
18       "created": "2019-11-29T20:43:00Z",
19       "eventTypeName": "BACKUP_AGENT_DOWN",
20       "groupId": "{PROJECT-ID}",
21       "id": "{ALERT-ID}",
22       "lastNotified": "2020-04-09T20:21:54Z",
23       "links": [],
24       "status": "OPEN",
25       "tags": [],
26       "typeName": "AGENT",
27       "updated": "2019-11-29T20:43:00Z"
28     },
29     {
30       "alertConfigId": "{ALERT-CONFIG-ID}",
31       "created": "2019-11-30T12:27:07Z",
32       "eventTypeName": "BACKUP_AGENT_DOWN",
33       "groupId": "{PROJECT-ID}",
34       "id": "{ALERT-ID}",
35       "lastNotified": "2020-04-09T20:20:33Z",
36       "links": [],
37       "status": "OPEN",
38       "tags": [],
39       "typeName": "AGENT",
40       "updated": "2019-11-30T12:27:07Z"
41     }
42   ],
43   "totalCount": 3
44 }

Volver

Alertas Globales

Obtenga uno

1	{
2	"links": [],
3	"results": [{
4	"alertConfigId": "{ALERT-CONFIG-ID}",
5	"created": "2019-11-29T20:26:30Z",
6	"eventTypeName": "BACKUP_AGENT_DOWN",
7	"groupId": "{PROJECT-ID}",
8	"id": "{ALERT-ID}",
9	"lastNotified": "2020-04-09T20:21:00Z",
10	"links": [],
11	"status": "OPEN",
12	"tags": [],
13	"typeName": "AGENT",
14	"updated": "2019-11-29T20:26:30Z"
15	},
16	{
17	"alertConfigId": "{ALERT-CONFIG-ID}",
18	"created": "2019-11-29T20:43:00Z",
19	"eventTypeName": "BACKUP_AGENT_DOWN",
20	"groupId": "{PROJECT-ID}",
21	"id": "{ALERT-ID}",
22	"lastNotified": "2020-04-09T20:21:54Z",
23	"links": [],
24	"status": "OPEN",
25	"tags": [],
26	"typeName": "AGENT",
27	"updated": "2019-11-29T20:43:00Z"
28	},
29	{
30	"alertConfigId": "{ALERT-CONFIG-ID}",
31	"created": "2019-11-30T12:27:07Z",
32	"eventTypeName": "BACKUP_AGENT_DOWN",
33	"groupId": "{PROJECT-ID}",
34	"id": "{ALERT-ID}",
35	"lastNotified": "2020-04-09T20:20:33Z",
36	"links": [],
37	"status": "OPEN",
38	"tags": [],
39	"typeName": "AGENT",
40	"updated": "2019-11-30T12:27:07Z"
41	}
42	],
43	"totalCount": 3
44	}

Roles necesarios

Solicitud

Parámetros de la ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument