Serviceオブジェクト

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

サービス

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

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

プロパティの動作:
- 読み取り専用
- 更新操作に必須
アルゴリズム 整数 ステータス計算ルール。子サービスが存在する場合にのみ適用されます。

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

プロパティの動作:
- 作成操作では 必須 です。
name 文字列 サービスの名前

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

可能な値: 0~999。

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

可能な値: 0~1000000

デフォルト: 0
propagation_rule 整数 ステータス伝搬ルール

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

プロパティの動作:
- 必須 propagation_value が設定されている場合
propagation_value 整数 ステータス伝播値

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 - 災害

プロパティの動作:
- 必須 if propagation_rule が設定されています
status 整数 サービスが正常状態か問題状態か

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

サービスが正常状態の場合、status は -1 になります。

プロパティの動作:
- 読み取り専用
description 文字列 サービスの説明
uuid 文字列 インポートされたサービスを既存のサービスにリンクするために使用される、Universal Unique Identifier(UUID)指定されていない場合は自動生成されます。
created_at 整数 サービスが作成された Unix タイムスタンプ
readonly boolean サービスへのアクセス

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

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

ステータスルール

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

プロパティ タイプ 説明
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 整数 制限値。

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

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

可能な値:
-1 - OK;
0 - 分類なし;
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 災害

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

可能な値:
0 - 分類なし;
1 - 情報;
2 - 警告;
3 - 平均;
4 - 高;
5 - 災害

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

サービスタグ

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

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

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

サービスアラーム

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

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

プロパティ タイプ 説明
clock timestamp サービスの状態変化が発生した時刻
整数 サービスのステータス

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

問題タグ

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

プロパティ タイプ 説明
タグ 文字列 問題タグ名

プロパティの動作:
- 必須
演算子 整数 マッピング条件演算子

可能な値:
0 - (デフォルト) 等しい;
2 - 似た
文字列 問題タグの値