View a markdown version of this page

ListRules - Amazon Managed Service for Prometheus

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

ListRules

ListRules 检索有关工作区中配置的规则的信息。

有效的 HTTP 动词：

GET

有效的 URI：

/workspaces/workspaceId/api/v1/rules

URL 查询参数：

type=<alert|record>仅返回警报规则（例如type=alert）或录制规则（例如type=record）。如果参数不存在或为空，则不进行筛选。可选

rule_name[]=<string>使用提供的名称筛选规则。提供多个过滤器时，规则名称必须满足至少一个给定过滤器。可选

rule_group[]=<string>使用提供的名称筛选规则组。提供多个过滤器时，规则组名称必须满足至少一个给定过滤器。可选

file[]=<string>使用提供的名称筛选规则组命名空间。提供多个过滤器时，规则组命名空间名称必须满足至少一个给定过滤器。可选

exclude_alerts=<true|false>设置为时，筛选没有任何活动警报的规则true。可选

match[]=<series_selector>仅返回配置了满足标签选择器的标签的规则。如果重复该参数，则返回与任何一组标签选择器匹配的规则。请注意，匹配位于每条规则定义中的标签上，而不是模板扩展后的值上（用于警报规则）。可选

group_limit=<number>单个响应中返回的最大规则组数。在随后的分页请求中，使用此响应中的groupNextToken属性来设置group_next_token参数。可选

group_next_token=<string>设置group_limit属性时，在上一次请求中返回的分页令牌。此标记用于对剩余的规则组进行迭代分页。可选

示例请求

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

示例响应

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