

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# API de alertas
<a name="v10-Grafana-API-Alerting"></a>

**nota**  
Esta sección solo se aplica a las alertas clásicas. Para obtener más información, consulte [Alertas de Grafana](alerts-overview.md).

Use la API de alertas para obtener información sobre las alertas clásicas del panel y sus estados. Sin embargo, esta API no se puede utilizar para modificar una alerta. Para crear alertas nuevas o modificarlas, debe actualizar el JSON del panel que contiene las alertas.

**nota**  
Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de cuenta de servicio válido. Lo incluye en el campo `Authorization` de la solicitud de API.

## Obtención de alertas
<a name="v10-Grafana-API-Alerting-get"></a>

```
GET /api/alerts
```

**Ejemplo de solicitud**

```
GET /api/alerts HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```

**Parámetros de cadenas de consulta:**

Estos parámetros se utilizan como parámetros de cadena de consulta. Por ejemplo: `/api/alerts?dashboardId=1`
+ **dashboardId**: limite las respuestas a las alertas en el valor especificado de paneles. Puede especificar varios paneles. Por ejemplo, `dashboardId=23&dashboardId=35`
+ **panelId**: limite la respuesta a la alerta de un panel especificado en un panel.
+ **query**: limite la respuesta a las alertas que tengan un nombre como este valor.
+ **state**: devuelva las alertas que tienen uno o más de los siguientes estados de alerta: `ALL`, `alerting`, `ok`, `no_data`, `paused` o `pending`. Para especificar varios estados, utilice el formato siguiente: `?state=paused&state=alerting`.
+ **limit**: limite la respuesta a un número X de alertas.
+ **folderId**: limite la respuesta a las alertas de los paneles de las carpetas especificadas. Puede especificar varias carpetas. Por ejemplo, `folderId=23&folderId=35`
+ **dashboardQuery**: limite la respuesta a las alertas que tengan un nombre de panel como este valor.
+ **dashboardTag**: limite las alertas de respuesta de los paneles con etiquetas específicas. Para hacer un filtrado “AND” con varias etiquetas, especifique el parámetro de etiquetas varias veces. Por ejemplo, `dashboardTag=tag1&dashboardTag=tag2`. Tenga en cuenta que se trata de etiquetas de Grafana, no AWS de etiquetas.

**Ejemplo de respuesta**

```
HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 1,
    "dashboardId": 1,
    "dashboardUId": "ABcdEFghij"
    "dashboardSlug": "sensors",
    "panelId": 1,
    "name": "fire place sensor",
    "state": "alerting",
    "newStateDate": "2018-05-14T05:55:20+02:00",
    "evalDate": "0001-01-01T00:00:00Z",
    "evalData": null,
    "executionError": "",
    "url": "http://grafana.com/dashboard/db/sensors"
  }
]
```

## Obtención de una alerta por ID
<a name="v10-Grafana-API-Alerting-getbyId"></a>

```
GET /api/alerts/:id
```

**Ejemplo de solicitud**

```
GET /api/alerts/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```

**Ejemplo de respuesta**

```
HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "dashboardId": 1,
  "dashboardUId": "ABcdEFghij"
  "dashboardSlug": "sensors",
  "panelId": 1,
  "name": "fire place sensor",
  "state": "alerting",
  "message": "Someone is trying to break in through the fire place",
  "newStateDate": "2018-05-14T05:55:20+02:00",
  "evalDate": "0001-01-01T00:00:00Z",
  "evalData": "evalMatches": [
    {
      "metric": "movement",
      "tags": {
        "name": "fireplace_chimney"
      },
      "value": 98.765
    }
  ],
  "executionError": "",
  "url": "http://grafana.com/dashboard/db/sensors"
}
```

**importante**  
Los datos de `evalMatches` se almacenan en caché en la base de datos exclusivamente cuando cambia el estado de la alerta. Si los datos de un servidor activan primero la alerta y, antes de que se vea que ese servidor abandona el estado de alerta, un segundo servidor también entra en un estado que activaría la alerta, el segundo servidor no está visible en los datos de `evalMatches`.

## Cómo pausar una alerta por ID
<a name="v10-Grafana-API-Alerting-pausebyId"></a>

```
POST /api/alerts/:id/pause
```

**Ejemplo de solicitud**

```
POST /api/alerts/1/pause HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "paused": true
}
```

El parámetro de consulta `:id` es el ID de la alerta que se va a pausar o dejar de pausar. `paused` puede ser `true` para pausar una alerta o `false` para dejar de pausarla.

**Ejemplo de respuesta**

```
HTTP/1.1 200
Content-Type: application/json

{
  "alertId": 1,
  "state":   "Paused",
  "message": "alert paused"
}
```