5.22.1 Blackbox exporterのリロード
- 機能
-
Blackbox exporterの定義ファイルを再読み込みし，Blackbox exporterの動作に反映します。
Blackbox exporterのリロードは，Blackbox exporterの再起動と比べて処理が速く，通知失敗時の状態を維持します。
- 形式
-
- リクエスト行
POST /-/reload HTTP/1.1
- リクエストヘッダー
-
ヘッダー名
設定値
Host
APIの接続先のBlackbox exporterのホストの情報を，ヘッダーの値として次の形式で指定します。
ホスト名またはIPアドレス:ポート番号
「:ポート番号」は省略可能です。
-
ホスト名またはIPアドレス
Blackbox exporterのホスト名またはIPv4アドレスを指定します。
-
ポート番号
Blackbox exporterに接続する際に使用するポート番号を指定します。
このヘッダーは省略不可です。
-
- リクエストのメッセージボディー
-
なし。
- レスポンスのメッセージボディー
-
リロードに成功した場合，レスポンスはなしです。
リロードに失敗した場合，失敗した要因を示すメッセージ（Blackbox exporterが出力する値）が設定されます。
- ステータスコード
-
ステータスコード
メッセージ
説明
200
OK
リロードに成功した。
200以外
OK以外
リロードに失敗した。
- 注意事項
-
-
不正な定義ファイルをリロードした場合，読み込んだ定義ファイルのすべての内容が無効となります。
-
リロードした内容は，次に実行するBlackbox exporterのAPI（スクレイプなど）から有効となり，実行中のAPIには影響しません。
-
- 使用例
-
OSSのcurlコマンドを利用して，このAPIを実行した場合の使用例を，次に示します。
リロード成功時：
>curl --request POST "http://localhost:20715/-/reload" >
リロード失敗時：
# curl -request POST http://localhost:20715/-/reload failed to reload config: error parsing config file: yaml: unmarshal errors: line 3: field priber not found in type config.plain