ダウンタイム

ダウンタイムの登録

ダウンタイムの設定をMackerelに登録します。

POST /api/v0/downtimes

APIキーに必要な権限

  • Read
  • Write

入力

以下のキーをもつオブジェクト。

KEY TYPE DESCRIPTION
name string ダウンタイム名
memo string [optional] ダウンタイムのメモ
start number ダウンタイム開始時刻 (epoch秒)
duration number ダウンタイム期間 (分)
recurrence recurrence [optional] 繰り返し設定
serviceScopes array[string] [optional] サービス対象スコープ。サービス名*の配列
serviceExcludeScopes array[string] [optional] サービス除外スコープ。サービス名*の配列
roleScopes array[string] [optional] ロール対象スコープ。ロール詳細名*の配列
roleExcludeScopes array[string] [optional] ロール除外スコープ。ロール詳細名*の配列
monitorScopes array[string] [optional] 監視設定対象スコープ。<monitor id>の配列
monitorExcludeScopes array[string] [optional] 監視設定除外スコープ。<monitor id>の配列

<recurrence> は以下のキーをもつオブジェクト。

KEY TYPE DESCRIPTION
type string 繰り返しの種類 (hourly, daily, weekly, monthly, yearly)
interval number 繰り返しの間隔
weekdays array[string] [optional] 曜日設定 (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday)。 typeweekly のときのみ有効
until number [optional] 繰り返し終了時刻 (epoch秒)

応答

成功時

id が付与されてダウンタイムが返却されます。

失敗時

STATUS CODE DESCRIPTION
400 入力が不正だったとき
400 名前やメモが長すぎるとき
400 ダウンタイム期間が正ではないとき
400 繰り返し設定が不正のとき
400 スコープの対象サービス・ロール・監視設定が重複している、または存在しないとき
400 スコープのサービス・ロール・監視設定が存在しないとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

* サービス名とロール詳細名

サービス名は <service name> 、ロールの詳細名は <service name>:<role name> というフォーマットの文字列です。

e.g. Hatena-Bookmark サービスならHatena-BookmarkHatena-Bookmark サービスの db-master ロールならHatena-Bookmark:db-master

使用できる文字列は /^[A-Za-z0-9][A-Za-z0-9_-]+$/


ダウンタイムの一覧

GET /api/v0/downtimes

APIキーに必要な権限

  • Read

応答

KEY TYPE DESCRIPTION
downtimes array[object] ダウンタイムのリスト

ダウンタイムの更新

PUT /api/v0/downtimes/<downtimeId>

APIキーに必要な権限

  • Read
  • Write

入力

ダウンタイムの作成と同様の形式です。

応答

成功時

更新後のダウンタイムをダウンタイムの作成と同様の形式で返します。

失敗時

STATUS CODE DESCRIPTION
400 入力が不正だったとき
400 名前やメモが長すぎるとき
400 ダウンタイム期間が正ではないとき
400 繰り返し設定が不正のとき
400 スコープの対象サービス・ロール・監視設定が重複している、または存在しないとき
400 スコープのサービス・ロール・監視設定が存在しないとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合
404 指定されたIDのダウンタイムがみつからないとき

ダウンタイムの削除

指定されたIDのダウンタイムを削除します。

DELETE /api/v0/downtimes/<downtimeId>

APIキーに必要な権限

  • Read
  • Write

応答

成功時

削除する直前のダウンタイムをダウンタイムの作成と同様の形式で返します。

失敗時

STATUS CODE DESCRIPTION
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合
404 指定されたIDのダウンタイムがみつからないとき