Media typeオブジェクト

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

メディアタイプ

メディアタイプオブジェクトには、次のプロパティがあります。

Property Type Description
mediatypeid ID メディアタイプのID。

Property behavior:
- read-only
- 更新操作では required
name string メディアタイプの名前。

Property behavior:
- 作成操作では required
type integer メディアタイプで使用するトランスポート。

Possible values:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Property behavior:
- 作成操作では required
exec_path string AlertScriptsPath サーバー設定パラメータで指定されたディレクトリにあるスクリプトファイル名（例: notification.sh）。

Property behavior:
- type が "Script" に設定されている場合は required
gsm_modem string GSMモデムのシリアルデバイス名。

Property behavior:
- type が "SMS" に設定されている場合は required
passwd string 認証パスワード。

Property behavior:
- smtp_authentication が "Normal password" に設定されている場合は supported
provider integer メールプロバイダー。

Possible values:
0 - (default) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string 通知の送信元メールアドレス。

Property behavior:
- type が "Email" に設定されている場合は required
smtp_helo string SMTP HELO。

Property behavior:
- type が "Email" に設定されている場合は supported
smtp_server string SMTPサーバー。

Property behavior:
- type が "Email" に設定されている場合は required
smtp_port integer 接続先のSMTPサーバーポート。

Default: 25.

Property behavior:
- type が "Email" に設定されている場合は supported
smtp_security integer 使用するSMTP接続のセキュリティレベル。

Possible values:
0 - (default) None;
1 - STARTTLS;
2 - SSL/TLS.

Property behavior:
- type が "Email" に設定されている場合は supported
smtp_verify_host integer SMTPのSSLホスト検証。

Possible values:
0 - (default) No;
1 - Yes.

Property behavior:
- smtp_security が "STARTTLS" または "SSL/TLS" に設定されている場合は supported
smtp_verify_peer integer SMTPのSSLピア検証。

Possible values:
0 - (default) No;
1 - Yes.

Property behavior:
- smtp_security が "STARTTLS" または "SSL/TLS" に設定されている場合は supported
smtp_authentication integer 使用するSMTP認証方式。

Possible values:
0 - (default) None;
1 - Normal password;
2 - OAuth token.
OAuth認証は Office365 relay メールプロバイダーでは使用できません。

Property behavior:
- type が "Email" に設定されている場合は supported
redirection_url string OAuth認可を戻すためのZabbix WebインターフェースURL。

Default:
API設定プロパティ url の値に zabbix.php?action=oauth.authorize を付加したもの

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
client_id string OAuth認可サーバーに登録されたクライアント識別子。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
client_secret string OAuth認可サーバーに登録されたクライアントシークレット。Super Adminタイプのユーザーのみアクセス可能です。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
authorization_url string アクセス トークンとリフレッシュ トークンを取得するための、パラメータ付きOAuth URL。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
token_url string 認可トークンをアクセス トークンおよびリフレッシュ トークンに交換するためのOAuth URL。
このURLは、無効なアクセス トークンを更新する際にもサーバーで使用されます。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
tokens_status integer トークンの状態を表すビットマスク。

Possible values:
0 - (default) Both tokens contain invalid value
1 - Access token contains valid value
2 - Refresh token contains valid value
3 - Both tokens contain valid value.

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は supported
access_token string OAuthアクセス トークンの値。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
access_token_updated timestamp refresh_token による更新時、またはトークン変更時のAPIによって、サーバーが access_token を最後に変更したタイムスタンプ。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は supported
access_expires_in integer access_token が期限切れとなり、refresh_url へのリクエストが必要になるまでの秒数。
access_token の更新時に Zabbix サーバーによって、またはトークン変更時にAPIによって設定されます。

タイムスタンプは access_token_updated の値を加算して計算されます。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は supported
refresh_token string OAuthリフレッシュ トークンの値。

Property behavior:
- smtp_authentication が "OAuth token" に設定されている場合は required
status integer メディアタイプが有効かどうか。

Possible values:
0 - (default) Enabled;
1 - Disabled.
username string ユーザー名。

Property behavior:
- smtp_authentication が "Normal password" に設定されている場合は supported
maxsessions integer 並列で処理できるアラートの最大数。

Possible values if type is set to "SMS": 1.

Possible values if type is set to "Email", "Script", or "Webhook": 0-100.

Default: 1.
maxattempts integer アラート送信の最大試行回数。

Possible values: 1-100.

Default: 3.
attempt_interval string 再試行間隔。
秒数および時間単位の接尾辞を受け付けます。

Possible values: 0-1h.

Default: 10s.
message_format integer メッセージ形式。

Possible values:
0 - Plain text;
1 - (default) HTML.

Property behavior:
- type が "Email" に設定されている場合は supported
script text Webhookスクリプト本体（JavaScript）。

Property behavior:
- type が "Webhook" に設定されている場合は required
timeout string Webhookスクリプトのタイムアウト。
秒数および時間単位の接尾辞を受け付けます。

Possible values: 1-60s.

Default: 30s.

Property behavior:
- type が "Webhook" に設定されている場合は supported
process_tags integer Webhookスクリプトのレスポンス内のJSONプロパティ値をタグとして処理します。これらのタグは、既存の問題タグに追加されます。

Possible values:
0 - (default) Ignore webhook script response;
1 - Process webhook script response as tags.

Property behavior:
- type が "Webhook" に設定されている場合は supported
show_event_menu integer カスタムURLへのリンクを含む event menu の項目を追加します。また、problem.get および event.get の出力に urls プロパティを追加します。

Possible values:
0 - (default) Do not include event menu entry or urls property;
1 - Include event menu entry and urls property.

Property behavior:
- type が "Webhook" に設定されている場合は supported
event_menu_url string event menu の項目および problem.get と event.get が返す urls プロパティで使用されるURL。

Property behavior:
- show_event_menu が "Include event menu entry and urls property" に設定されている場合は supported
event_menu_name string event menu の項目および problem.get と event.get が返す urls プロパティで使用される名前。

Property behavior:
- show_event_menu が "Include event menu entry and urls property" に設定されている場合は supported
parameters array Webhook または script のパラメータ。

Property behavior:
- type が "Webhook" または "Script" に設定されている場合は supported
description text メディアタイプの説明。

webhookパラメータ

webhookパラメータには以下のプロパティがあります。

プロパティ Type 説明
name string パラメータ名。

プロパティの動作:
- 必須
value string パラメータ値。マクロをサポートします。
サポートされるマクロについては、サポートされるマクロページを参照してください。

スクリプトパラメータ

スクリプトパラメータには以下のプロパティがあります。

プロパティ 型 説明
sortorder integer パラメータ値がコマンドライン引数としてスクリプトに渡される順序です。最初の引数は 0 から始まります。

プロパティの動作:
- 必須
value string パラメータ値です。マクロをサポートします。
サポートされるマクロについては、サポートされるマクロページを参照してください。

メッセージテンプレート

メッセージテンプレートオブジェクトは、通知を送信するためのアクションの実行時にデフォルトメッセージとして使用されるテンプレートを定義します。以下のプロパティがあります。

プロパティ Type 説明
eventsource integer イベントソース。

使用可能な値:
0 - トリガー;
1 - ディスカバリ;
2 - 自動登録;
3 - 内部;
4 - サービス。

プロパティの動作:
- 必須
recovery integer 実行モード。

使用可能な値:
0 - 実行;
1 - 復旧時の実行;
2 - 更新時の実行。

プロパティの動作:
- 必須
subject string メッセージの件名。
message string メッセージ本文。