Serviceオブジェクト

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

サービス

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

プロパティ 説明
serviceid ID サービスのID。

プロパティの動作:
- 読み取り専用
- 更新操作では 必須
algorithm integer ステータス計算ルール。子サービスが存在する場合にのみ適用されます。

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

プロパティの動作:
- 作成操作では 必須
name string サービス名。

プロパティの動作:
- 作成操作では 必須
sortorder integer ソートに使用されるサービスの位置。

指定可能な値: 0-999。

プロパティの動作:
- 作成操作では 必須
weight integer サービスの重み。

指定可能な値: 0-1000000。

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

指定可能な値:
0 - (デフォルト) サービスのステータスを変更せずそのまま伝播する;
1 - 指定された propagation_value だけ伝播されるステータスを増加させる(重大度を1~5段階上げる);
2 - 指定された propagation_value だけ伝播されるステータスを減少させる(重大度を1~5段階下げる);
3 - このサービスを無視する - ステータスは親サービスにまったく伝播されない;
4 - 指定された propagation_value を使用して固定のサービスステータスを設定する。

プロパティの動作:
- propagation_value が設定されている場合は 必須
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 - 致命的な障害。

プロパティの動作:
- propagation_rule が設定されている場合は 必須
status integer サービスがOK状態か問題状態か。

サービスが問題状態の場合、status は次のいずれかに等しくなります:
- 最も重大な問題の重大度;
- 問題状態にある子サービスの中で最も高いステータス。

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

プロパティの動作:
- 読み取り専用
description string サービスの説明。
uuid string インポートされたサービスを既存のサービスに関連付けるために使用される汎用一意識別子。指定されていない場合は自動生成されます。
created_at integer サービスが作成された日時のUnixタイムスタンプ。
readonly integer サービスへのアクセス。

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

プロパティの動作:
- 読み取り専用

ステータスルール

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

Property Type Description
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

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

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

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

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

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

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

プロパティの動作:
- 必須

サービスタグ

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

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

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

サービスアラーム

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

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

プロパティ Type 説明
clock timestamp サービスの状態変更が発生した時刻。
value integer サービスのステータス。

使用可能な値の一覧については、service status プロパティを参照してください。

障害タグ

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

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

プロパティの動作:
- 必須
operator integer operator 条件のマッピング。

使用可能な値:
0 - (デフォルト) Equals;
2 - Contains.
value string 障害タグの値。