5.21.6　Alertmanagerのサイレンス取得

機能

指定したサイレンスをJSON形式で取得します。

形式

リクエスト行

GET /api/v2/silence/サイレンスID HTTP/1.1

サイレンスIDには，「Alertmanagerのサイレンス一覧取得」APIで取得する値，「Alertmanagerのサイレンス作成」APIの戻り値として返却される値を指定できます。

リクエストヘッダー

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

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

なし

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

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

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

「5.21.3 Alertmanagerのサイレンス一覧取得」APIの「レスポンスのパラメーター」を参照してください。

ステータスコード

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

使用例

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

> curl --request GET "http://localhost:20714/api/v2/silence/00ed3d4d-da1f-4971-81cd-b2687933e602"
{
    "id":"00ed3d4d-da1f-4971-81cd-b2687933e602",
    "status":{
        "state":"active"
    },
    "updatedAt":"2022-08-09T03:35:41.821Z",
    "comment":"cc",
    "createdBy":"aa",
    "endsAt":"2022-08-09T05:35:32.825Z",
    "matchers":[
        {
            "isEqual":true,
            "isRegex":false,
            "name":"env",
            "value":"production"
        }
    ],
    "startsAt":"2022-08-09T03:35:41.821Z"
}

ページの先頭へ

5.21.6 Alertmanagerのサイレンス取得

5.21.6　Alertmanagerのサイレンス取得