Serviceオブジェクト

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

サービス

サービスオブジェクトには次のプロパティがあります。

Property Type Description
serviceid ID サービスのID。

Property behavior:
- read-only
- 更新操作では required
algorithm integer ステータス計算ルール。子サービスが存在する場合にのみ適用されます。

可能な値:
0 - ステータスをOKに設定する;
1 - すべての子に障害がある場合、最も重大なものを使用する;
2 - 子サービスの中で最も重大なものを使用する。

Property behavior:
- 作成操作では required
name string サービス名。

Property behavior:
- 作成操作では required
sortorder integer 並べ替えに使用されるサービスの位置。

可能な値: 0-999。

Property behavior:
- 作成操作では required
weight integer サービスの重み。

可能な値: 0-1000000。

デフォルト: 0。
propagation_rule integer ステータス伝播ルール。

可能な値:
0 - (default) サービスのステータスをそのまま伝播する - 変更なし;
1 - 指定した propagation_value だけ伝播ステータスを上げる（1〜5段階）;
2 - 指定した propagation_value だけ伝播ステータスを下げる（1〜5段階）;
3 - このサービスを無視する - ステータスは親サービスにまったく伝播されない;
4 - 指定した propagation_value を使用して固定のサービスステータスを設定する。

Property behavior:
- propagation_value が設定されている場合は required
propagation_value integer ステータス伝播値。

propagation_rule が "0" または "3" に設定されている場合の可能な値:
0 - 未分類。

propagation_rule が "1" または "2" に設定されている場合の可能な値:
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 重大。

propagation_rule が "4" に設定されている場合の可能な値:
-1 - OK;
0 - 未分類;
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 重大。

Property behavior:
- propagation_rule が設定されている場合は required
status integer サービスがOK状態か障害状態かを示します。

サービスが障害状態の場合、status は最も重大な障害の深刻度、または障害状態の子サービスの最も高いステータスのいずれかに等しくなります。

サービスがOK状態の場合、status は -1 に等しくなります。

Property behavior:
- read-only
description string サービスの説明。
uuid string インポートされたサービスを既存のサービスにリンクするために使用される、ユニバーサル一意識別子です。指定されていない場合は自動生成されます。
created_at integer サービスが作成されたUnixタイムスタンプ。
readonly integer サービスへのアクセス。

可能な値:
0 - 読み書き可能;
1 - 読み取り専用。

Property behavior:
- read-only

ステータスルール

ステータスルールオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
type integer (新しいステータス) ステータスを設定する条件。

使用可能な値:
0 - 少なくとも (N) 個の子サービスが (ステータス) ステータス以上である場合;
1 - 少なくとも (N%) の子サービスが (ステータス) ステータス以上である場合;
2 - (ステータス) ステータス以下の子サービスが (N) 個未満である場合;
3 - (ステータス) ステータス以下の子サービスが (N%) 未満である場合;
4 - (ステータス) ステータス以上の子サービスの重みの合計が少なくとも (W) である場合;
5 - (ステータス) ステータス以上の子サービスの重みの合計が少なくとも (N%) である場合;
6 - (ステータス) ステータス以下の子サービスの重みの合計が (W) 未満である場合;
7 - (ステータス) ステータス以下の子サービスの重みの合計が (N%) 未満である場合。

ここで:
- N (W) は limit_value;
- (ステータス) は limit_status;
- (新しいステータス) は new_status。

プロパティの動作:
- required
limit_value integer 制限値。

使用可能な値:
- N および W の場合: 1-100000;
- N% の場合: 1-100。

プロパティの動作:
- required
limit_status integer 制限ステータス。

使用可能な値:
-1 - OK;
0 - 未分類;
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 障害。

プロパティの動作:
- required
new_status integer 新しいステータス値。

使用可能な値:
0 - 未分類;
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 障害。

プロパティの動作:
- required

サービスタグ

サービスタグオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
tag string サービスタグ名。

プロパティの動作:
- 必須
value string サービスタグの値。

サービスアラーム

サービスアラームは、Zabbix API を使用して直接作成、更新、削除することはできません。

サービスアラームオブジェクトは、サービスの状態変化を表します。 次のプロパティがあります。

Property Type Description
clock timestamp サービスの状態変化が発生した時刻。
value integer サービスのステータス。

取りうる値の一覧については、service status property を参照してください。

障害タグ

障害タグを使用すると、サービスを障害イベントに関連付けることができます。 障害タグオブジェクトには、次のプロパティがあります。

Property Type Description
tag string 障害タグ名。

Property behavior:
- required
operator integer マッピング条件 operator。

Possible values:
0 - (default) Equals;
2 - Contains.
value string 障害タグの値。