[comment]: # aside: 1

[comment]: # ({9e9adb41-b1a89f1b})
# Serviceオブジェクト

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

[comment]: # ({/9e9adb41-b1a89f1b})

[comment]: # ({92b0166a-5d7a3d70})
### サービス

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

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|serviceid|ID|サービスのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*<br>- 更新操作では *必須*|
|algorithm|integer|ステータス計算ルール。子サービスが存在する場合にのみ適用されます。<br><br>指定可能な値:<br>0 - ステータスをOKに設定;<br>1 - すべての子に問題がある場合、最も重大なもの;<br>2 - 子サービスの中で最も重大なもの。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- 作成操作では *必須*|
|name|string|サービス名。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- 作成操作では *必須*|
|sortorder|integer|ソートに使用されるサービスの位置。<br><br>指定可能な値: 0-999。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- 作成操作では *必須*|
|weight|integer|サービスの重み。<br><br>指定可能な値: 0-1000000。<br><br>デフォルト: 0。|
|propagation\_rule|integer|ステータス伝播ルール。<br><br>指定可能な値:<br>0 - *(デフォルト)* サービスのステータスを変更せずそのまま伝播する;<br>1 - 指定された `propagation_value` だけ伝播されるステータスを増加させる（重大度を1～5段階上げる）;<br>2 - 指定された `propagation_value` だけ伝播されるステータスを減少させる（重大度を1～5段階下げる）;<br>3 - このサービスを無視する - ステータスは親サービスにまったく伝播されない;<br>4 - 指定された `propagation_value` を使用して固定のサービスステータスを設定する。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- `propagation_value` が設定されている場合は *必須*|
|propagation\_value|integer|ステータス伝播値。<br><br>`propagation_rule` が "0" または "3" に設定されている場合の指定可能な値:<br>0 - 未分類。<br><br>`propagation_rule` が "1" または "2" に設定されている場合の指定可能な値:<br>1 - 情報;<br>2 - 警告;<br>3 - 軽度の障害;<br>4 - 重度の障害;<br>5 - 致命的な障害。<br><br>`propagation_rule` が "4" に設定されている場合の指定可能な値:<br>-1 - OK;<br>0 - 未分類;<br>1 - 情報;<br>2 - 警告;<br>3 - 軽度の障害;<br>4 - 重度の障害;<br>5 - 致命的な障害。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- `propagation_rule` が設定されている場合は *必須*|
|status|integer|サービスがOK状態か問題状態か。<br><br>サービスが問題状態の場合、`status` は次のいずれかに等しくなります:<br>- 最も重大な問題の重大度;<br>- 問題状態にある子サービスの中で最も高いステータス。<br><br>サービスがOK状態の場合、`status` は -1 に等しくなります。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|
|description|string|サービスの説明。|
|uuid|string|インポートされたサービスを既存のサービスに関連付けるために使用される汎用一意識別子。指定されていない場合は自動生成されます。|
|created_at|integer|サービスが作成された日時のUnixタイムスタンプ。|
|readonly|integer|サービスへのアクセス。<br><br>指定可能な値:<br>0 - 読み書き可能;<br>1 - 読み取り専用。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|

[comment]: # ({/92b0166a-5d7a3d70})

[comment]: # ({dd16f497-c2041847})
### ステータスルール

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|type|integer|(新しいステータス) ステータスを設定する条件。<br><br>使用可能な値:<br>0 - 少なくとも (N) 個の子サービスが (ステータス) ステータス以上である場合;<br>1 - 少なくとも (N%) の子サービスが (ステータス) ステータス以上である場合;<br>2 - (N) 個未満の子サービスが (ステータス) ステータス以下である場合;<br>3 - (N%) 未満の子サービスが (ステータス) ステータス以下である場合;<br>4 - (ステータス) ステータス以上の子サービスの重みの合計が少なくとも (W) である場合;<br>5 - (ステータス) ステータス以上の子サービスの重みの合計が少なくとも (N%) である場合;<br>6 - (ステータス) ステータス以下の子サービスの重みの合計が (W) 未満である場合;<br>7 - (ステータス) ステータス以下の子サービスの重みの合計が (N%) 未満である場合。<br><br>ここで:<br>- N (W) は `limit_value`;<br>- (ステータス) は `limit_status`;<br>- (新しいステータス) は `new_status`。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|limit\_value|integer|制限値。<br><br>使用可能な値:<br>- N および W の場合: 1-100000;<br>- N% の場合: 1-100。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|limit\_status|integer|制限ステータス。<br><br>使用可能な値:<br>-1 - OK;<br>0 - 未分類;<br>1 - 情報;<br>2 - 警告;<br>3 - 平均;<br>4 - 高;<br>5 - 障害。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|new\_status|integer|新しいステータス値。<br><br>使用可能な値:<br>0 - 未分類;<br>1 - 情報;<br>2 - 警告;<br>3 - 平均;<br>4 - 高;<br>5 - 障害。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|

[comment]: # ({/dd16f497-c2041847})

[comment]: # ({72128b59-c301cfb2})
### サービスタグ

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

|プロパティ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|tag|string|サービスタグ名。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|value|string|サービスタグの値。|

[comment]: # ({/72128b59-c301cfb2})

[comment]: # ({56809270-e6daa7b4})
### サービスアラーム

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

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

|プロパティ |[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|clock|timestamp|サービスの状態変更が発生した時刻。|
|value|integer|サービスのステータス。<br><br>使用可能な値の一覧については、[service `status` プロパティ](object#service)を参照してください。|

[comment]: # ({/56809270-e6daa7b4})

[comment]: # ({10d32ffb-6b88d3dc})
### 障害タグ

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

|プロパティ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|tag|string|障害タグ名。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|operator|integer|[operator](/manual/it_services/service_tree#service-configuration) 条件のマッピング。<br><br>使用可能な値:<br>0 - *(デフォルト)* Equals;<br>2 - Contains.|
|value|string|障害タグの値。|

[comment]: # ({/10d32ffb-6b88d3dc})
