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