アラートグループ設定の一覧
GET
/api/v0/alert-group-settings
APIキーに必要な権限
- Read
応答
成功時
{ "alertGroupSettings": [<alertGroupSetting>, <alertGroupSetting>, ...] }
<alertGroupSetting> は以下のキーを持つオブジェクトです。
| KEY | TYPE | DESCRIPTION |
|---|---|---|
id |
string | アラートグループ設定ID |
name |
string | アラートグループ設定の名称 |
memo |
string | [optional] このアラートグループ設定に関するメモ |
serviceScopes |
array[string] | [optional] サービス対象スコープ。サービス名の配列 |
roleScopes |
array[string] | [optional] ロール対象スコープ。ロール詳細名の配列 *1 |
monitorScopes |
array[string] | [optional] 監視ルール対象スコープ。監視ルールIDの配列 |
notificationInterval |
number | [optional] 通知の再送設定をするときの再送間隔 (分) |
*1 ロール詳細名
ロールの詳細な名前は <service name>:<role name> というフォーマットの文字列です。
| e.g. | Hatena-Bookmark サービスの db-master ロールならHatena-Bookmark:db-master |
|---|
使用できる文字列は /^[A-Za-z0-9][A-Za-z0-9_-]+$/。
アラートグループ設定の作成
POST
/api/v0/alert-group-settings
APIキーに必要な権限
- Read
- Write
入力
| KEY | TYPE | DESCRIPTION |
|---|---|---|
name |
string | アラートグループ設定の名称 |
memo |
string | [optional] このアラートグループ設定に関するメモ |
serviceScopes |
array[string] | [optional] サービス対象スコープ。サービス名の配列 |
roleScopes |
array[string] | [optional] ロール対象スコープ。ロール詳細名の配列 *1 |
monitorScopes |
array[string] | [optional] 監視ルール対象スコープ。監視ルールIDの配列 |
notificationInterval |
number | [optional] 通知の再送設定をするときの再送間隔 (分) |
応答
成功時
作成されたアラートグループ設定の情報が返却されます。形式はアラートグループ設定の一覧で取得できるアラートグループ設定の形式と同様です。
失敗時
| STATUS CODE | DESCRIPTION |
|---|---|
| 400 | 入力が不正であるとき |
| 403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
アラートグループ設定の取得
GET
/api/v0/alert-group-settings/<alertGroupSettingId>
APIキーに必要な権限
- Read
応答
成功時
アラートグループ設定の情報が返却されます。形式はアラートグループ設定の一覧で取得できるアラートグループ設定の形式と同様です。
失敗時
| STATUS CODE | DESCRIPTION |
|---|---|
| 400 | 入力が不正であるとき |
| 404 | 指定されたIDのアラートグループ設定がみつからないとき |
| 403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
アラートグループ設定の更新
PUT
/api/v0/alert-group-settings/<alertGroupSettingId>
APIキーに必要な権限
- Read
- Write
入力
アラートグループ設定の作成と同様の形式です。
応答
成功時
更新されたアラートグループ設定の情報が返却されます。形式はアラートグループ設定の一覧で取得できるアラートグループ設定の形式と同様です。
失敗時
| STATUS CODE | DESCRIPTION |
|---|---|
| 400 | 入力が不正であるとき |
| 404 | 指定されたIDのアラートグループ設定がみつからないとき |
| 403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
アラートグループ設定の削除
DELETE
/api/v0/alert-group-settings/<alertGroupSettingId>
APIキーに必要な権限
- Read
- Write
応答
成功時
削除されたアラートグループ設定の情報が返却されます。形式はアラートグループ設定の一覧で取得できるアラートグループ設定の形式と同様です。
失敗時
| STATUS CODE | DESCRIPTION |
|---|---|
| 400 | 入力が不正であるとき |
| 404 | 指定されたIDのアラートグループ設定がみつからないとき |
| 403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
