View a markdown version of this page

ListRules - Amazon Managed Service für Prometheus

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ListRules

Der ListRules Vorgang ruft Informationen zu den im Workspace konfigurierten Regeln ab.

Eine einzelne Antwort enthält höchstens 100.000 Regeln. Da Regelgruppen niemals auf mehrere Seiten aufgeteilt werden, führt das Kürzen immer zu einer Regelgruppengrenze. Eine Antwort kann daher weniger als 100.000 Regeln enthalten, wenn die Aufnahme der nächsten Regelgruppe die Obergrenze überschreitet. Wenn eine Kürzung erfolgt, enthält die Antwort die groupNextToken Eigenschaft. Um die nächste Seite abzurufen, übergeben Sie diesen Wert als group_next_token Abfrageparameter, den Sie zusammen mit group_limit senden müssen.

Gültige HTTP-Verben:

GET

Gültige URI:

/workspaces/workspaceId/api/v1/rules

URL-Abfrageparameter:

type=<alert|record>Gibt nur die Warnungsregeln (zum Beispieltype=alert) oder die Aufzeichnungsregeln (zum Beispiel,type=record) zurück. Wenn der Parameter fehlt oder leer ist, wird keine Filterung durchgeführt. Optional

rule_name[]=<string>Filtert Regeln anhand der angegebenen Namen. Wenn mehrere Filter bereitgestellt werden, muss der Regelname mindestens einem der angegebenen Filter entsprechen. Optional

rule_group[]=<string>Filtert Regelgruppen anhand der angegebenen Namen. Wenn mehrere Filter bereitgestellt werden, muss der Name der Regelgruppe mindestens einem der angegebenen Filter entsprechen. Optional

file[]=<string>Filtert Regelgruppen-Namespaces anhand der angegebenen Namen. Wenn mehrere Filter bereitgestellt werden, muss der Name des Regelgruppen-Namespaces mindestens einem der angegebenen Filter entsprechen. Optional

exclude_alerts=<true|false>Filtert Regeln ohne aktive Benachrichtigungen, wenn diese Einstellung auf true gesetzt ist. Optional

match[]=<series_selector>Gibt nur Regeln zurück, für die Labels konfiguriert wurden, die den Label-Selektoren entsprechen. Wenn der Parameter wiederholt wird, werden Regeln zurückgegeben, die mit einer der Gruppen von Labelselektoren übereinstimmen. Beachten Sie, dass sich der Abgleich auf die Labels in der Definition der einzelnen Regeln bezieht, nicht auf die Werte nach der Erweiterung der Vorlage (bei Warnungsregeln). Optional

group_limit=<number>Maximale Anzahl von Regelgruppen, die in einer einzigen Antwort zurückgegeben wurden. Verwenden Sie bei nachfolgenden Anfragen zur Paginierung die groupNextToken Eigenschaft aus dieser Antwort, um den group_next_token Parameter festzulegen. Optional

group_next_token=<string>Das Paginierungstoken, das von einer vorherigen Anfrage zurückgegeben wurde, wenn Sie die group_limit Eigenschaft festgelegt haben oder wenn die Antwort die Obergrenze von 100.000 Regeln erreicht. Verwenden Sie dieses Token, um die verbleibenden Regelgruppen iterativ zu paginieren. Wenn Sie diesen Parameter verwenden, müssen Sie den group_limit Parameter auch senden. Optional

Beispielanforderung

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

Beispielantwort

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