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> 指定された名前を使用してルールをフィルタリングします。複数のフィルターを指定する場合、ルール名は指定されたフィルターの少なくとも 1 つを満たす必要があります。オプションです。

rule_group[]=<string> 指定された名前を使用してルールグループをフィルタリングします。複数のフィルターを指定する場合、ルールグループ名は指定されたフィルターの少なくとも 1 つを満たす必要があります。オプションです。

file[]=<string> 指定された名前を使用してルールグループ名前空間をフィルタリングします。複数のフィルターを指定する場合、ルールグループ名前空間名は指定されたフィルターの少なくとも 1 つを満たす必要があります。オプションです。

exclude_alerts=<true|false> に設定すると、アクティブなアラートなしでルールをフィルタリングしますtrue。オプションです。

match[]=<series_selector> ラベルセレクタを満たすラベルを設定したルールのみを返します。パラメータが繰り返されると、ラベルセレクタのいずれかのセットに一致するルールが返されます。テンプレート拡張後の値 (アラートルールの場合) ではなく、各ルールの定義のラベルに一致があることに注意してください。オプションです。

group_limit=<number> 1 回のレスポンスで返されるルールグループの最大数。以降のページ分割リクエストでは、このレスポンスの 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": ""
}