Maintenanceオブジェクト

次のオブジェクトは、maintenanceAPIに直接関連しています。

メンテナンス

メンテナンスオブジェクトには以下のプロパティがあります。

プロパティ 型 説明
maintenanceid ID メンテナンスの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 メンテナンス期間の長さ（秒単位）。

指定した値は分単位に切り捨てられます。

指定可能な値の範囲: 300 - 86399940。

デフォルト: 3600。
timeperiod_type integer 時間帯のタイプ。

指定可能な値:
0 - (デフォルト) 1回のみ;
2 - 毎日;
3 - 毎週;
4 - 毎月。
start_date timestamp メンテナンス期間を有効にする日時。
指定した値は分単位に切り捨てられます。

デフォルト: 現在の日付。

プロパティの動作:
- timeperiod_type が「1回のみ」に設定されている場合に サポート
start_time integer メンテナンス開始時刻の時刻部分（秒単位）。
指定した値は分単位に切り捨てられます。

デフォルト: 0。

プロパティの動作:
- timeperiod_type が「毎日」、「毎週」、または「毎月」に設定されている場合に サポート
every integer 毎日および毎週の期間では、every はメンテナンスを有効にする日または週の間隔を定義します。
timeperiod_type が「毎日」または「毎週」に設定されている場合のデフォルト値: 1。

毎月の期間で day が設定されている場合、every プロパティはメンテナンスを有効にする月の日を定義します。
timeperiod_type が「毎月」に設定され、day が設定されている場合のデフォルト値: 1。

毎月の期間で dayofweek が設定されている場合、every プロパティはメンテナンスを有効にする月の週を定義します。
timeperiod_type が「毎月」に設定され、dayofweek が設定されている場合の指定可能な値:
1 - (デフォルト) 第1週;
2 - 第2週;
3 - 第3週;
4 - 第4週;
5 - 最終週。

プロパティの動作:
- timeperiod_type が「毎日」、「毎週」、または「毎月」に設定されている場合に サポート
dayofweek integer メンテナンスを有効にする曜日。

指定可能なビットマップ値:
1 - 月曜日;
2 - 火曜日;
4 - 水曜日;
8 - 木曜日;
16 - 金曜日;
32 - 土曜日;
64 - 日曜日。

これはビットマスクフィールドです。指定可能なビットマップ値の任意の合計を指定できます（たとえば、月曜日・水曜日・金曜日の場合は 21）。

プロパティの動作:
- timeperiod_type が「毎週」に設定されている場合、または timeperiod_type が「毎月」に設定されていて day が設定されていない場合に 必須
day integer メンテナンスを有効にする月の日。

プロパティの動作:
- timeperiod_type が「毎月」に設定されていて dayofweek が設定されていない場合に 必須
month integer メンテナンスを有効にする月。

指定可能なビットマップ値:
1 - 1月;
2 - 2月;
4 - 3月;
8 - 4月;
16 - 5月;
32 - 6月;
64 - 7月;
128 - 8月;
256 - 9月;
512 - 10月;
1024 - 11月;
2048 - 12月。

これはビットマスクフィールドです。指定可能なビットマップ値の任意の合計を指定できます（たとえば、1月・4月・7月・10月の場合は 585）。

プロパティの動作:
- timeperiod_type が「毎月」に設定されている場合に 必須

障害タグ

障害タグオブジェクトは、メンテナンスが有効になった際にどの障害を抑制する必要があるかを定義するために使用されます。
タグは、メンテナンスオブジェクト の maintenance_type が「データ収集あり」に設定されている場合にのみ指定できます。
このオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
tag string 障害タグ名。

プロパティの動作:
- 必須
operator integer 条件の演算子。

使用可能な値:
0 - 等しい;
2 - (デフォルト) 含む。
value string 障害タグの値。