View a markdown version of this page

ListRules - Amazon Managed Service per Prometheus

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

ListRules

ListRules recupera informazioni sulle regole configurate nell'area di lavoro.

Verbi HTTP validi:

GET

URI validi:

/workspaces/workspaceId/api/v1/rules

URL dei parametri delle domande:

type=<alert|record>Restituisce solo le regole di avviso (ad esempio,type=alert) o le regole di registrazione (ad esempio,). type=record Quando il parametro è assente o vuoto, non viene eseguito alcun filtro. Facoltativo

rule_name[]=<string>Filtra le regole utilizzando i nomi forniti. Quando vengono forniti più filtri, il nome della regola deve soddisfare almeno uno dei filtri specificati. Facoltativo

rule_group[]=<string>Filtra i gruppi di regole utilizzando i nomi forniti. Quando vengono forniti più filtri, il nome del gruppo di regole deve soddisfare almeno uno dei filtri specificati. Facoltativo

file[]=<string>Filtra gli spazi dei nomi dei gruppi di regole utilizzando i nomi forniti. Quando vengono forniti più filtri, il nome dello spazio dei nomi del gruppo di regole deve soddisfare almeno uno dei filtri specificati. Facoltativo

exclude_alerts=<true|false>Filtra le regole senza avvisi attivi se impostato su. true Facoltativo

match[]=<series_selector>Restituisce solo le regole con etichette configurate che soddisfano i selettori di etichette. Se il parametro viene ripetuto, vengono restituite le regole che corrispondono a uno qualsiasi dei set di selettori di etichette. Tieni presente che la corrispondenza si verifica sulle etichette nella definizione di ogni regola, non sui valori dopo l'espansione del modello (per le regole di avviso). Facoltativo

group_limit=<number>Numero massimo di gruppi di regole restituiti in una singola risposta. Nelle richieste successive di impaginazione, utilizzate la groupNextToken proprietà di questa risposta per impostare il group_next_token parametro. Facoltativo

group_next_token=<string>Il token di impaginazione restituito nella richiesta precedente quando la group_limit proprietà è stata impostata. Questo token viene utilizzato per impaginare in modo iterativo i gruppi di regole rimanenti. Facoltativo

Richiesta di esempio

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

Risposta di esempio

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