Skip to content
Permalink
Browse files

Unified name for monitoring rules

  • Loading branch information
a-know committed Oct 18, 2019
1 parent e2f0949 commit 5e8fa7aa07e76204a4c02c9fe147a7cd8ec8ec2a
@@ -45,7 +45,7 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
| `memo` | *string* | [optional] このアラートグループ設定に関するメモ |
| `serviceScopes` | *array[string]* | [optional] サービス対象スコープ。サービス名の配列 |
| `roleScopes` | *array[string]* | [optional] ロール対象スコープ。ロール詳細名の配列 [*1](#role-fullname) |
| `monitorScopes` | *array[string]* | [optional] 監視設定対象スコープ。監視設定IDの配列 |
| `monitorScopes` | *array[string]* | [optional] 監視ルール対象スコープ。監視ルールIDの配列 |
| `notificationInterval` | *number* | [optional] 通知の再送設定をするときの再送間隔 (分) |

<h4 id="role-fullname">*1 ロール詳細名</h4>
@@ -85,7 +85,7 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
| `memo` | *string* | [optional] このアラートグループ設定に関するメモ |
| `serviceScopes` | *array[string]* | [optional] サービス対象スコープ。サービス名の配列 |
| `roleScopes` | *array[string]* | [optional] ロール対象スコープ。ロール詳細名の配列 [*1](#role-fullname) |
| `monitorScopes` | *array[string]* | [optional] 監視設定対象スコープ。監視設定IDの配列 |
| `monitorScopes` | *array[string]* | [optional] 監視ルール対象スコープ。監視ルールIDの配列 |
| `notificationInterval` | *number* | [optional] 通知の再送設定をするときの再送間隔 (分) |

### 応答
@@ -56,11 +56,11 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
| -------- | ------ | ----------- |
| `id` | *string* | アラートのid。 |
| `status` | *string* | アラートの現在のステータス `"OK"`、 `"CRITICAL"`、 `"WARNING"`、 `"UNKNOWN"` のいずれかになります。 |
| `monitorId` | *string* | アラートを発生させた監視設定のid。 |
| `type` | *string* | 監視設定の種別。疎通 (`"connectivity"`)、ホストメトリック (`"host"`)、サービスメトリック (`"service"`)、外形監視 (`"external"`)、チェック監視 (`"check"`)、式監視 (`"expression"`)、ロール内異常検知 (`"anomalyDetection"`) のいずれかになります。 |
| `hostId` | *string* | [optional] 関連するホストのid。監視設定の種別が `"connectivity"`、`"host"`、`"check"`、`"anomalyDetection"`の時のみ存在します。 |
| `value` | *number* | [optional] 監視対象の値。監視設定の種別が `"host"`、`"service"` の時または `"external"`で応答時間の設定があるときのみ存在します。 |
| `message` | *string* | [optional] 監視対象のメッセージ。監視設定の種別が `"check"` の時または `"external"` の時のみ存在します。 |
| `monitorId` | *string* | アラートを発生させた監視ルールのid。 |
| `type` | *string* | 監視ルールの種別。疎通 (`"connectivity"`)、ホストメトリック (`"host"`)、サービスメトリック (`"service"`)、外形監視 (`"external"`)、チェック監視 (`"check"`)、式監視 (`"expression"`)、ロール内異常検知 (`"anomalyDetection"`) のいずれかになります。 |
| `hostId` | *string* | [optional] 関連するホストのid。監視ルールの種別が `"connectivity"`、`"host"`、`"check"`、`"anomalyDetection"`の時のみ存在します。 |
| `value` | *number* | [optional] 監視対象の値。監視ルールの種別が `"host"`、`"service"` の時または `"external"`で応答時間の設定があるときのみ存在します。 |
| `message` | *string* | [optional] 監視対象のメッセージ。監視ルールの種別が `"check"` の時または `"external"` の時のみ存在します。 |
| `reason` | *string* | [optional] アラートを閉じた理由。アラートが解決していない時は存在しません。 |
| `openedAt` | *number* | アラートの発生時刻 (epoch秒) |
| `closedAt` | *number* | [optional] アラートの解決時刻 (epoch秒)。アラートが既に解決している時のみ存在します。 |
@@ -41,8 +41,8 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
| `serviceExcludeScopes` | *array[string]* | [optional] サービス除外スコープ。サービス名[*](#service-name-and-role-fullname)の配列 |
| `roleScopes` | *array[string]* | [optional] ロール対象スコープ。ロール詳細名[*](#service-name-and-role-fullname)の配列 |
| `roleExcludeScopes` | *array[string]* | [optional] ロール除外スコープ。ロール詳細名[*](#service-name-and-role-fullname)の配列 |
| `monitorScopes` | *array[string]* | [optional] 監視設定対象スコープ。`<monitor id>`の配列 |
| `monitorExcludeScopes` | *array[string]* | [optional] 監視設定除外スコープ。`<monitor id>`の配列 |
| `monitorScopes` | *array[string]* | [optional] 監視ルール対象スコープ。`<monitor id>`の配列 |
| `monitorExcludeScopes` | *array[string]* | [optional] 監視ルール除外スコープ。`<monitor id>`の配列 |

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

@@ -84,11 +84,11 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</tr>
<tr>
<td>400</td>
<td>スコープの対象サービス・ロール・監視設定が重複している、または存在しないとき</td>
<td>スコープの対象サービス・ロール・監視ルールが重複している、または存在しないとき</td>
</tr>
<tr>
<td>400</td>
<td>スコープのサービス・ロール・監視設定が存在しないとき</td>
<td>スコープのサービス・ロール・監視ルールが存在しないとき</td>
</tr>
<tr>
<td>403</td>
@@ -180,11 +180,11 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</tr>
<tr>
<td>400</td>
<td>スコープの対象サービス・ロール・監視設定が重複している、または存在しないとき</td>
<td>スコープの対象サービス・ロール・監視ルールが重複している、または存在しないとき</td>
</tr>
<tr>
<td>400</td>
<td>スコープのサービス・ロール・監視設定が存在しないとき</td>
<td>スコープのサービス・ロール・監視ルールが存在しないとき</td>
</tr>
<tr>
<td>403</td>
@@ -379,11 +379,11 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</div>

<div class="index-row">
<h3><a href="entry/monitors">監視設定</a></h3>
<h3><a href="entry/monitors">監視ルール</a></h3>
<div class="apis">
<div class="api">
<a href="entry/monitors#create">
<p>監視設定の登録</p>
<p>監視ルールの登録</p>
<p class="type-post">
<code>POST</code>
<code>/api/v0/monitors</code>
@@ -392,7 +392,7 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</div>
<div class="api">
<a href="entry/monitors#list">
<p>監視設定の一覧</p>
<p>監視ルールの一覧</p>
<p class="type-get">
<code>GET</code>
<code>/api/v0/monitors</code>
@@ -401,7 +401,7 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</div>
<div class="api">
<a href="entry/monitors#get">
<p>監視設定の取得</p>
<p>監視ルールの取得</p>
<p class="type-get">
<code>GET</code>
<code>/api/v0/monitors/<em>&lt;monitorId&gt;</em></code>
@@ -410,7 +410,7 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</div>
<div class="api">
<a href="entry/monitors#update">
<p>監視設定の更新</p>
<p>監視ルールの更新</p>
<p class="type-put">
<code>PUT</code>
<code>/api/v0/monitors/<em>&lt;monitorId&gt;</em></code>
@@ -419,7 +419,7 @@ EditURL: https://blog.hatena.ne.jp/mackerelio/mackerelio-api-jp.hatenablog.macke
</div>
<div class="api">
<a href="entry/monitors#delete">
<p>監視設定の削除</p>
<p>監視ルールの削除</p>
<p class="type-delete">
<code>DELETE</code>
<code>/api/v0/monitors/<em>&lt;monitorId&gt;</em></code>

0 comments on commit 5e8fa7a

Please sign in to comment.
You can’t perform that action at this time.