View a markdown version of this page

ListRules - Amazon Managed Service for Prometheus

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

ListRules

O ListRules recupera informações sobre as regras configuradas no espaço de trabalho.

Verbos HTTP válidos:

GET

URIs válidos:

/workspaces/workspaceId/api/v1/rules

Parâmetros da consulta de URL:

type=<alert|record>Retorne somente as regras de alerta (por exemplo,type=alert) ou as regras de gravação (por exemplo,type=record). Quando o parâmetro está ausente ou vazio, nenhuma filtragem é feita. Opcional

rule_name[]=<string>Filtra as regras usando os nomes fornecidos. Quando vários filtros são fornecidos, o nome da regra deve satisfazer pelo menos um dos filtros fornecidos. Opcional

rule_group[]=<string>Filtra grupos de regras usando os nomes fornecidos. Quando vários filtros são fornecidos, o nome do grupo de regras deve satisfazer pelo menos um dos filtros fornecidos. Opcional

file[]=<string>Filtra os namespaces do grupo de regras usando os nomes fornecidos. Quando vários filtros são fornecidos, o nome do namespace do grupo de regras deve satisfazer pelo menos um dos filtros fornecidos. Opcional

exclude_alerts=<true|false>Filtra as regras sem nenhum alerta ativo quando definido comotrue. Opcional

match[]=<series_selector>Somente retorne regras que tenham rótulos configurados que satisfaçam os seletores de rótulos. Se o parâmetro for repetido, as regras que correspondam a qualquer um dos conjuntos de seletores de rótulos serão retornadas. Observe que a correspondência está nos rótulos na definição de cada regra, não nos valores após a expansão do modelo (para regras de alerta). Opcional

group_limit=<number>Número máximo de grupos de regras retornados em uma única resposta. Nas solicitações subsequentes de paginação, use a groupNextToken propriedade dessa resposta para definir o group_next_token parâmetro. Opcional

group_next_token=<string>O token de paginação retornado na solicitação anterior quando a group_limit propriedade foi definida. Esse token é usado para paginar iterativamente os demais grupos de regras. Opcional

Exemplo de solicitação

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

Exemplo de resposta

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