

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

**catatan**  
Bagian ini hanya berlaku untuk peringatan klasik. Untuk informasi selengkapnya, lihat [Grafana memperingatkan](alerts-overview.md).

Gunakan Preferences API untuk mendapatkan informasi tentang lansiran dasbor klasik dan statusnya. Namun, Anda tidak dapat menggunakan API ini untuk memodifikasi peringatan. Untuk membuat peringatan baru atau memodifikasinya, Anda perlu memperbarui dasbor JSON yang berisi peringatan.

**catatan**  
Untuk menggunakan API Grafana dengan ruang kerja Grafana yang Dikelola Amazon, Anda harus memiliki token akun layanan yang valid. Anda menyertakan ini di `Authorization` bidang dalam permintaan API.

## Dapatkan peringatan
<a name="v10-Grafana-API-Alerting-get"></a>

```
GET /api/alerts
```

**Permintaan contoh**

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

**Parameter Querystring:**

Parameter ini digunakan sebagai parameter querystring. Misalnya: `/api/alerts?dashboardId=1`
+ **DashboardID** — Batasi respons terhadap peringatan dalam nilai dasbor yang ditentukan. Anda dapat menentukan beberapa dasbor. Sebagai contoh, `dashboardId=23&dashboardId=35`.
+ **PaneLid** - Batasi respons untuk peringatan untuk panel tertentu di dasbor.
+ **query** — Batasi respons terhadap peringatan yang memiliki nama seperti nilai ini.
+ **state** — Kembalikan peringatan yang memiliki satu bijih lebih dari status peringatan berikut:`ALL`,,`alerting`,`ok`, `no_data``paused`, atau`pending`. Untuk menentukan beberapa status, gunakan format berikut: `?state=paused&state=alerting`
+ **limit** — Batasi respons terhadap jumlah peringatan X.
+ **FolderId** — Batasi respons terhadap peringatan dasbor di folder yang ditentukan. Anda dapat menentukan beberapa folder. Sebagai contoh, `folderId=23&folderId=35`.
+ **DashboardQuery** - Batasi respons terhadap peringatan yang memiliki nama dasbor seperti nilai ini.
+ **DashboardTag** — Batasi peringatan respons dasbor dengan tag tertentu. Untuk melakukan pemfilteran “AND” dengan beberapa tag, tentukan parameter tag beberapa kali. Misalnya, `dashboardTag=tag1&dashboardTag=tag2`. Perhatikan bahwa ini adalah tag Grafana, bukan AWS tag.

**Contoh respon**

```
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"
  }
]
```

## Dapatkan peringatan dengan Id
<a name="v10-Grafana-API-Alerting-getbyId"></a>

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

**Permintaan contoh**

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

**Contoh respon**

```
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"
}
```

**penting**  
`evalMatches`data di-cache dalam database ketika dan hanya ketika keadaan peringatan berubah. Jika data dari satu server memicu peringatan terlebih dahulu dan, sebelum server itu terlihat meninggalkan status peringatan, server kedua juga memasuki status yang akan memicu peringatan, server kedua tidak terlihat dalam data. `evalMatches`

## Jeda peringatan oleh Id
<a name="v10-Grafana-API-Alerting-pausebyId"></a>

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

**Permintaan contoh**

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

{
  "paused": true
}
```

Parameter `:id` kueri adalah Id dari peringatan yang akan dijeda atau tidak dijeda. `paused`bisa `true` untuk menjeda peringatan atau `false` untuk membatalkan jeda peringatan.

**Contoh respon**

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

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