View a markdown version of this page

ListRules - Servicio administrado por Amazon para Prometheus

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ListRules

La ListRules operación recupera información sobre las reglas configuradas en el espacio de trabajo.

Una sola respuesta contiene como máximo 100 000 reglas. Como los grupos de reglas nunca se dividen en páginas, el truncamiento siempre se sitúa en el límite de un grupo de reglas. Por lo tanto, una respuesta puede contener menos de 100 000 reglas si al incluir el siguiente grupo de reglas se supera el límite. Cuando se produce un truncamiento, la respuesta incluye la groupNextToken propiedad. Para recuperar la página siguiente, pase ese valor como parámetro de group_next_token consulta, que debe enviar junto con él. group_limit

Verbos HTTP válidos:

GET

URI válidos:

/workspaces/workspaceId/api/v1/rules

Parámetros de consulta de URL:

type=<alert|record>Devuelve solo las reglas de alerta (por ejemplo,type=alert) o las reglas de registro (por ejemplo,type=record). Cuando el parámetro está ausente o vacío, no se realiza ningún filtrado. Opcional

rule_name[]=<string>Filtra las reglas con los nombres proporcionados. Cuando se proporcionan varios filtros, el nombre de la regla debe cumplir con al menos uno de los filtros indicados. Opcional

rule_group[]=<string>Filtra los grupos de reglas con los nombres proporcionados. Cuando se proporcionan varios filtros, el nombre del grupo de reglas debe cumplir con al menos uno de los filtros indicados. Opcional

file[]=<string>Filtra los espacios de nombres de los grupos de reglas con los nombres proporcionados. Cuando se proporcionan varios filtros, el nombre del espacio de nombres del grupo de reglas debe cumplir al menos uno de los filtros indicados. Opcional

exclude_alerts=<true|false>Filtra las reglas sin ninguna alerta activa cuando se establece en. true Opcional

match[]=<series_selector>Solo devuelven las reglas que tienen etiquetas configuradas que cumplen con los selectores de etiquetas. Si se repite el parámetro, se devuelven las reglas que coinciden con cualquiera de los conjuntos de selectores de etiquetas. Tenga en cuenta que la coincidencia se encuentra en las etiquetas de la definición de cada regla, no en los valores después de la expansión de la plantilla (en el caso de las reglas de alerta). Opcional

group_limit=<number>Número máximo de grupos de reglas devueltos en una sola respuesta. En las siguientes solicitudes de paginación, utilice la groupNextToken propiedad de esta respuesta para establecer el group_next_token parámetro. Opcional

group_next_token=<string>El token de paginación devuelto por una solicitud anterior al establecer la group_limit propiedad o cuando la respuesta alcanza el límite máximo de 100 000 reglas. Usa este token para paginar de forma iterativa los grupos de reglas restantes. Al usar este parámetro, también debe enviarlo. group_limit Opcional

Solicitud de ejemplo

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

Respuesta de ejemplo

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