Media typeオブジェクト

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

メディアタイプ

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

プロパティ 型 説明
mediatypeid ID メディアタイプのID。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
name string メディアタイプの名前。

プロパティの動作:
- 作成操作では必須
type integer メディアタイプで使用する転送方式。

指定可能な値:
0 - メール;
1 - スクリプト;
2 - SMS;
4 - webhook。

プロパティの動作:
- 作成操作では必須
exec_path string AlertScriptsPath サーバー設定パラメータで指定されたディレクトリに配置されているスクリプトファイル（notification.sh など）の名前。

プロパティの動作:
- type が「Script」に設定されている場合は必須
gsm_modem string GSMモデムのシリアルデバイス名。

プロパティの動作:
- type が「SMS」に設定されている場合は必須
passwd string 認証パスワード。

プロパティの動作:
- smtp_authentication が「Normal password」に設定されている場合にサポート
provider integer メールプロバイダー。

指定可能な値:
0 - (デフォルト) 汎用SMTP;
1 - Gmail;
2 - Gmailリレー;
3 - Office365;
4 - Office365リレー。
smtp_email string 通知の送信元メールアドレス。

プロパティの動作:
- type が「Email」に設定されている場合は必須
smtp_helo string SMTP HELO。

プロパティの動作:
- type が「Email」に設定されている場合にサポート
smtp_server string SMTPサーバー。

プロパティの動作:
- type が「Email」に設定されている場合は必須
smtp_port integer 接続先のSMTPサーバーポート。

デフォルト: 25。

プロパティの動作:
- type が「Email」に設定されている場合にサポート
smtp_security integer 使用するSMTP接続のセキュリティレベル。

指定可能な値:
0 - (デフォルト) なし;
1 - STARTTLS;
2 - SSL/TLS。

プロパティの動作:
- type が「Email」に設定されている場合にサポート
smtp_verify_host integer SMTPのSSLホスト検証。

指定可能な値:
0 - (デフォルト) いいえ;
1 - はい。

プロパティの動作:
- smtp_security が「STARTTLS」または「SSL/TLS」に設定されている場合にサポート
smtp_verify_peer integer SMTPのSSLピア検証。

指定可能な値:
0 - (デフォルト) いいえ;
1 - はい。

プロパティの動作:
- smtp_security が「STARTTLS」または「SSL/TLS」に設定されている場合にサポート
smtp_authentication integer 使用するSMTP認証方式。

指定可能な値:
0 - (デフォルト) なし;
1 - 通常のパスワード;
2 - OAuthトークン。
Office365リレーメールプロバイダーではOAuth認証は使用できません。

プロパティの動作:
- type が「Email」に設定されている場合にサポート
redirection_url string OAuth認証に戻るためのZabbix WebインターフェースURL。

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

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
client_id string OAuth認証サーバーに登録されたクライアント識別子。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
client_secret string OAuth認証サーバーに登録されたクライアントシークレット。スーパーユーザータイプのユーザーのみアクセスできます。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
authorization_url string アクセストークンおよびリフレッシュトークンを取得するためのパラメータ付きOAuth URL。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
token_url string 認証トークンをアクセストークンおよびリフレッシュトークンと交換するためのOAuth URL。
このURLは、無効なアクセストークンを更新するためにもサーバーによって使用されます。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
tokens_status integer トークンの状態を示すビットマスク。

指定可能な値:
0 - (デフォルト) 両方のトークンに無効な値が含まれる
1 - アクセストークンに有効な値が含まれる
2 - リフレッシュトークンに有効な値が含まれる
3 - 両方のトークンに有効な値が含まれる。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合にサポート
access_token string OAuthアクセストークンの値。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
access_token_updated timestamp refresh_token を使用した更新時、またはトークン変更時にAPIによってサーバーが access_token を最後に変更した時刻。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合にサポート
access_expires_in integer access_token が期限切れになり、refresh_url へのリクエストが必要になるまでの秒数。
これは、access_token の更新時にZabbixサーバーによって設定されるか、トークン変更時にAPIによって設定されます。

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

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合にサポート
refresh_token string OAuthリフレッシュトークンの値。

プロパティの動作:
- smtp_authentication が「OAuth token」に設定されている場合は必須
status integer メディアタイプが有効かどうか。

指定可能な値:
0 - (デフォルト) 有効;
1 - 無効。
username string ユーザー名。

プロパティの動作:
- smtp_authentication が「Normal password」に設定されている場合にサポート
maxsessions integer 並列処理できるアラートの最大数。

type が「SMS」に設定されている場合の指定可能な値: 1。

type が「Email」、「Script」、または「Webhook」に設定されている場合の指定可能な値: 0-100。

デフォルト: 1。
maxattempts integer アラートの送信を試行する最大回数。

指定可能な値: 1-100。

デフォルト: 3。
attempt_interval string 再試行間隔。
秒数（例: 1、30、60）、または時間のサフィックス付きの値（例: 30s、1m、1h）を指定できます。

指定可能な値: 0-1h。

デフォルト: 10s。
message_format integer メッセージ形式。

指定可能な値:
0 - プレーンテキスト;
1 - (デフォルト) HTML。

プロパティの動作:
- type が「Email」に設定されている場合にサポート
script text webhookスクリプト本体（JavaScript）。

プロパティの動作:
- type が「Webhook」に設定されている場合は必須
timeout string webhookスクリプトのタイムアウト。
秒数（例: 1、60）、または時間のサフィックス付きの値（例: 30s、1m）を指定できます。

指定可能な値: 1-60s。

デフォルト: 30s。

プロパティの動作:
- type が「Webhook」に設定されている場合にサポート
process_tags integer webhookスクリプトのレスポンスに含まれるJSONプロパティ値をタグとして処理します。これらのタグは既存の障害タグに追加されます。

指定可能な値:
0 - (デフォルト) webhookスクリプトのレスポンスを無視;
1 - webhookスクリプトのレスポンスをタグとして処理。

プロパティの動作:
- type が「Webhook」に設定されている場合にサポート
show_event_menu integer カスタムURLへのリンクを含む項目をイベントメニューに追加します。また、problem.getおよびevent.getの出力に urls プロパティを追加します。

指定可能な値:
0 - (デフォルト) イベントメニュー項目または urls プロパティを含めない;
1 - イベントメニュー項目と urls プロパティを含める。

プロパティの動作:
- type が「Webhook」に設定されている場合にサポート
event_menu_url string イベントメニュー項目およびproblem.getとevent.getが返す urls プロパティで使用するURL。

プロパティの動作:
- show_event_menu が「イベントメニュー項目と urls プロパティを含める」に設定されている場合にサポート
event_menu_name string イベントメニュー項目およびproblem.getとevent.getが返す urls プロパティで使用する名前。

プロパティの動作:
- show_event_menu が「イベントメニュー項目と urls プロパティを含める」に設定されている場合にサポート
parameters array Webhookまたはスクリプトのパラメータ。

プロパティの動作:
- type が「Webhook」または「Script」に設定されている場合にサポート
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 メッセージ本文。