5.21.3　Alertmanagerのサイレンス一覧取得

機能

Alertmanagerに作成されているサイレンスの一覧をJSON形式で取得します。

形式

リクエスト行

GET /api/v2/silences HTTP/1.1

リクエストヘッダー

ヘッダー名	設定値
Host	APIの接続先のAlertmanagerのホストの情報を，ヘッダーの値として次の形式で指定します。ホスト名またはIPアドレス`:`ポート番号「`:`ポート番号」は省略可能です。ホスト名またはIPアドレス Alertmanagerのホスト名またはIPv4アドレスを指定します。ポート番号 Alertmanagerに接続する際に使用するポート番号を指定します。このヘッダーは省略不可です。

リクエストのメッセージボディー

なし。

レスポンスのメッセージボディー

[
    {
        "id": "サイレンスID",
        "status": {
            "state": "ステータス"
        },
        "updatedAt": "更新日時",
        "comment": "コメント",
        "createdBy": "作成者名",
        "endsAt": "終了日時",
        "matchers": [
            {
                "isRegex":正規表現フラグ,
                "name": "ラベル名",
                "value": "値"
            },
            ・・・
        ],
        "startsAt": "開始日時"
    },
    ・・・
]

レスポンスのパラメーター

メンバー名		データ型	説明
id		string	サイレンスの設定に対して一意に割り振られるIDが設定されます。「サイレンス失効」APIを実行する際に使用します。 Alertmanagerが自動的に設定します。
status		object	サイレンスの状態を表すオブジェクトです。 Alertmanagerが自動的に設定します。
	state	string	次のどれかの値が設定されます。 active サイレンスの設定が有効である。 pending 適用開始日時を経過していない。 expired 適用終了日時を経過している。 Alertmanagerが自動的に設定します。
updatedAt		string	サイレンスの設定の作成日時または更新日時がISO8601拡張形式で設定されます。 Alertmanagerが自動的に設定します。
matchers		object	アラートの発行を抑止する条件が設定されます。nameとvalueで指定したラベル名とラベルの値に一致するアラートの発行を抑止します。
	name	string	ラベル名が設定されます。
	value	string	ラベルの値が設定されます。
	isRegex	boolean	valueの値を正規表現で指定しているかどうかが設定されます。 true 正規表現で指定している。 false 正規表現で指定していない。
	isEqual	boolean	matchersに該当した場合にアラート通知を抑止するかどうかが設定されます。常に「true」（アラート通知を抑止する）が設定されます。 Alertmanagerが自動的に設定します。
startsAt		string	サイレンスの適用開始日時がISO8601拡張形式で設定されます。日時は「サイレンス作成」APIで指定したタイムゾーンとなります。
endsAt		string	サイレンスの適用終了日時がISO8601拡張形式で設定されます。日時は「サイレンス作成」APIで指定したタイムゾーンとなります。
createdBy		string	サイレンスの設定の作成者名が設定されます。
comment		string	サイレンスの設定のコメントが設定されます。

ステータスコード

ステータスコード	メッセージ	説明
200	OK	サイレンスの一覧取得に成功した。
200以外	OK以外	サイレンスの一覧取得に失敗した。

使用例

OSSのcurlコマンドを利用して，このAPIを実行した場合の使用例を，次に示します。下記の使用例では，見やすくするために改行とインデントを追加しています。実際の出力結果には改行とインデントは出力されません。また，JSONのプロパティの出力順は不定です。

>curl --request GET "http://localhost:20714/api/v2/silences"
[
    {
        "id": "787594fd-29a6-495d-921a-d37709f6186e",
        "status": {
            "state": "pending"
        },
        "updatedAt": "2021-08-07T02:02:56.206Z",
        "comment": "cpu alert silence",
        "createdBy": "api",
        "endsAt": "2021-08-15T05:00:00.000Z",
        "matchers": [
            {
                "isEqual": true,
                "isRegex": false,
                "name": "alertname",
                "value": "cpu alert"
            }
        ],
        "startsAt": "2021-08-15T04:00:00.000Z"
    }
]
>

ページの先頭へ

5.21.3 Alertmanagerのサイレンス一覧取得

5.21.3　Alertmanagerのサイレンス一覧取得