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