Documentation
Table of Contents
> Maintenanceオブジェクト
次のオブジェクトは、maintenanceAPIに直接関連しています。
メンテナンス
メンテナンスオブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| maintenanceid | string | (読取専用)メンテナンスのID |
| name (必須) |
string | メンテナンス名 |
| active_since (必須) |
timestamp | メンテナンスがアクティブになる時間。 指定された値は分に切り捨てられます。 |
| active_till (必須) |
timestamp | メンテナンスがノンアクティブになる時間。 指定された値は分に切り捨てられます。 |
| description | string | メンテナンスの説明 |
| maintenance_type | integer | メンテナンスの種類 利用可能な値: 0 - (デフォルト)データ収集あり 1 - データ収集なし |
| tags_evaltype | integer | 障害タグの評価方法 可能な値: 0 - (デフォルト) And/Or 2 - Or |
期間
期間オブジェクトは、メンテナンスを有効にする必要がある期間を定義するために使用されます。 以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| period | integer | メンテナンス期間（秒単位） 指定された値は分で切り捨てられます デフォルト:3600 |
| timeperiod_type | integer | 期間のタイプ 可能な値: 0 - (デフォルト)1回のみ 2 - 毎日 3 - 毎週 4 - 毎月 |
| start_date | timestamp | メンテナンス期間を有効にする日 1つの期間にのみ使用されます。 指定された値は分で切り捨てられます。 デフォルト:現在の日付 |
| start_time | integer | メンテナンスが開始される時刻(秒単位) 毎日、毎週、毎月の期間に使用されます。 指定された値は分で切り捨てられます。 デフォルト:0 |
| every | integer | 毎日、毎週、毎月の期間で使用されます。 毎日および毎週の期間では”すべて"はメンテナンスを有効にする必要がある日または週の間隔を定義します。 デフォルト:1 毎月の期間で、 dayofweekプロパティに少なくとも1つの選択された曜日が含まれている場合、everyプロパティはメンテナンスを有効にする必要がある月の週を定義します。可能な値:< br>1 - (デフォルト)第1週 2 - 第2週 3 - 第3週 4 - 第4週 5 - 先週 |
| dayofweek | integer | メンテナンスを有効にする曜日 バイナリ形式で保存され、各ビットは対応する日を表します。 たとえば4はバイナリで100に等しく、水曜日にメンテナンスが有効になることを意味します。 毎週および毎月の期間に使用されます。 毎週のみ必須です。 毎月の期間には、少なくとも1つの「dayofweek」または「day」を指定する必要があります。 |
| day | integer | メンテナンスを有効にする必要がある月の日 毎月にのみ使用されます 毎月の期間には、少なくとも1つの「曜日」または「日」を指定する必要があります。 |
| month | integer | メンテナンスを有効にする月。 バイナリ形式で保存され、各ビットは対応する月を表します。 たとえば5はバイナリで101に等しく、メンテナンスが1月と3月に有効になることを意味します。 毎月の期間のときのみ必須です |
障害タグ
障害タグオブジェクトは、メンテナンスが有効になったときにどの障害を抑制しなければならないかを定義するために使用されます。 以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| tag (必須) |
string | 障害タグ名 |
| operator | integer | 条件演算子 可能な値: 0 - 等しい 2 - (デフォルト)含む |
| value | string | 障害タグ値 |
タグはデータ収集("maintenance_type ":0)を使用したメンテナンス期間にのみ指定できます。