View a markdown version of this page

ListRules - Amazon Managed Service for Prometheus

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

ListRules

ListRulesOperasi mengambil informasi tentang aturan yang dikonfigurasi di ruang kerja.

Satu respons berisi paling banyak 100.000 aturan. Karena grup aturan tidak pernah dibagi di seluruh halaman, pemotongan selalu mendarat di batas grup aturan. Oleh karena itu, respons dapat berisi kurang dari 100.000 aturan jika menyertakan kelompok aturan berikutnya melebihi batas. Ketika pemotongan terjadi, responsnya mencakup properti. groupNextToken Untuk mengambil halaman berikutnya, berikan nilai itu sebagai parameter group_next_token kueri, yang harus Anda kirim bersamagroup_limit.

Kata kerja HTTP yang valid:

GET

URI yang valid:

/workspaces/workspaceId/api/v1/rules

Parameter kueri URL:

type=<alert|record>Kembalikan hanya aturan peringatan (misalnya,type=alert) atau aturan perekaman (misalnya,type=record). Ketika parameter tidak ada atau kosong, tidak ada penyaringan yang dilakukan. Opsional

rule_name[]=<string>Memfilter aturan menggunakan nama yang disediakan. Ketika beberapa filter disediakan, nama aturan harus memenuhi setidaknya satu dari filter yang diberikan. Opsional

rule_group[]=<string>Memfilter grup aturan menggunakan nama yang disediakan. Ketika beberapa filter disediakan, nama grup aturan harus memenuhi setidaknya satu dari filter yang diberikan. Opsional

file[]=<string>Memfilter ruang nama grup aturan menggunakan nama yang disediakan. Ketika beberapa filter disediakan, nama namespace grup aturan harus memenuhi setidaknya satu dari filter yang diberikan. Opsional

exclude_alerts=<true|false>Memfilter aturan tanpa peringatan aktif saat disetel ketrue. Opsional

match[]=<series_selector>Hanya mengembalikan aturan yang telah mengonfigurasi label yang memenuhi pemilih label. Jika parameter diulang, aturan yang cocok dengan salah satu set pemilih label dikembalikan. Perhatikan bahwa pencocokan ada pada label dalam definisi setiap aturan, bukan pada nilai setelah ekspansi templat (untuk aturan peringatan). Opsional

group_limit=<number>Jumlah maksimum grup aturan yang dikembalikan dalam satu respons. Dalam permintaan berikutnya untuk paginate, gunakan groupNextToken properti dari respons ini untuk mengatur group_next_token parameter. Opsional

group_next_token=<string>Token pagination dikembalikan oleh permintaan sebelumnya saat Anda menyetel group_limit properti atau ketika respons mencapai batas 100.000 aturan. Gunakan token ini untuk melakukan paginasi berulang pada grup aturan yang tersisa. Bila Anda menggunakan parameter ini, Anda juga harus mengirim group_limit parameter. Opsional

Permintaan sampel

GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/rules HTTP/1.1
Content-Length: 0, 
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0

Sampel respon

HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 423
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin

{
    "status": "success",
    "data": {
        "groups": [
            {
                "name": "test-1.rules",
                "file": "test-rules",
                "rules": [
                    {
                        "name": "record:1",
                        "query": "sum(rate(node_cpu_seconds_total[10m:1m]))",
                        "labels": {},
                        "health": "ok",
                        "lastError": "",
                        "type": "recording",
                        "lastEvaluation": "2021-10-21T21:22:34.429565909Z",
                        "evaluationTime": 0.001005399
                    }
                ],
                "interval": 60,
                "lastEvaluation": "2021-10-21T21:22:34.429563992Z",
                "evaluationTime": 0.001010504
            }
        ]
    },
    "errorType": "",
    "error": ""
}