View a markdown version of this page

ListRules - Amazon Managed Service for Prometheus

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListRules

ListRules récupère des informations sur les règles configurées dans l’espace de travail.

Verbes HTTP valides :

GET

URI valides :

/workspaces/workspaceId/api/v1/rules

Paramètres de requête d’URL :

type=<alert|record>Renvoie uniquement les règles d'alerte (par exemple,type=alert) ou les règles d'enregistrement (par exemple,type=record). Lorsque le paramètre est absent ou vide, aucun filtrage n'est effectué. Facultatif

rule_name[]=<string>Filtre les règles en utilisant les noms fournis. Lorsque plusieurs filtres sont fournis, le nom de la règle doit satisfaire au moins l'un des filtres indiqués. Facultatif

rule_group[]=<string>Filtre les groupes de règles en utilisant les noms fournis. Lorsque plusieurs filtres sont fournis, le nom du groupe de règles doit satisfaire au moins l'un des filtres indiqués. Facultatif

file[]=<string>Filtre les espaces de noms des groupes de règles en utilisant les noms fournis. Lorsque plusieurs filtres sont fournis, le nom de l'espace de noms du groupe de règles doit satisfaire au moins l'un des filtres indiqués. Facultatif

exclude_alerts=<true|false>Filtre les règles sans aucune alerte active lorsqu'elle est définie surtrue. Facultatif

match[]=<series_selector>Renvoie uniquement les règles qui ont configuré des étiquettes conformes aux sélecteurs d'étiquettes. Si le paramètre est répété, les règles correspondant à l'un des ensembles de sélecteurs d'étiquettes sont renvoyées. Notez que la correspondance se fait sur les étiquettes de la définition de chaque règle, et non sur les valeurs après l'extension du modèle (pour les règles d'alerte). Facultatif

group_limit=<number>Nombre maximal de groupes de règles renvoyés dans une seule réponse. Dans les demandes de pagination suivantes, utilisez la groupNextToken propriété de cette réponse pour définir le group_next_token paramètre. Facultatif

group_next_token=<string>Le jeton de pagination renvoyé dans la demande précédente lorsque la group_limit propriété a été définie. Ce jeton est utilisé pour paginer de manière itérative sur les groupes de règles restants. Facultatif

Exemple de demande

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

Exemple de réponse

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