Media typeオブジェクト
次のオブジェクトは、mediatypeAPIに直接関連しています。
メディアタイプ
メディアタイプオブジェクトには、以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| mediatypeid | ID | メディアタイプのID。 プロパティの動作: - 読み取り専用 - 更新操作で 必須 |
| name | string | メディアタイプの名前。 プロパティの動作: - 作成操作で 必須 |
| type | integer | メディアタイプで使用される転送方式。 指定可能な値: 0 - メール; 1 - スクリプト; 2 - SMS; 4 - webhook。 プロパティの動作: - 作成操作で 必須 |
| exec_path | string | AlertScriptsPath サーバー設定パラメータで指定されたディレクトリに配置されているスクリプトファイル名（例: notification.sh）。 プロパティの動作: - type が「スクリプト」に設定されている場合は 必須 |
| gsm_modem | string | GSMモデムのシリアルデバイス名。 プロパティの動作: - type が「SMS」に設定されている場合は 必須 |
| passwd | string | 認証パスワード。 プロパティの動作: - smtp_authentication が「通常のパスワード」に設定されている場合に サポート |
| provider | integer | メールプロバイダー。 指定可能な値: 0 - (デフォルト) 汎用SMTP; 1 - Gmail; 2 - Gmail relay; 3 - Office365; 4 - Office365 relay. |
| smtp_email | string | 通知の送信元となるメールアドレス。 プロパティの動作: - type が「メール」に設定されている場合は 必須 |
| smtp_helo | string | SMTP HELO。 プロパティの動作: - type が「メール」に設定されている場合に サポート |
| smtp_server | string | SMTPサーバー。 プロパティの動作: - type が「メール」に設定されている場合は 必須 |
| smtp_port | integer | 接続先のSMTPサーバーポート。 デフォルト: 25。 プロパティの動作: - type が「メール」に設定されている場合に サポート |
| smtp_security | integer | 使用するSMTP接続のセキュリティレベル。 指定可能な値: 0 - (デフォルト) なし; 1 - STARTTLS; 2 - SSL/TLS。 プロパティの動作: - type が「メール」に設定されている場合に サポート |
| 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 relay メールプロバイダーではOAuth認証は使用できません。 プロパティの動作: - type が「メール」に設定されている場合に サポート |
| redirection_url | string | OAuth認可をリダイレクトして戻すためのZabbix Webインターフェース URL。 デフォルト: API設定プロパティ url の値に zabbix.php?action=oauth.authorize の部分を付加したものプロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| client_id | string | OAuth認可サーバー内で登録されたクライアント識別子。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| client_secret | string | OAuth認可サーバー内で登録されたクライアントシークレット。Super Adminタイプのユーザーのみアクセスできます。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| authorization_url | string | アクセスおよびリフレッシュトークンを取得するための、パラメータ付きOAuth URL。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| token_url | string | アクセスおよびリフレッシュトークンに交換するためのOAuth URL。 このURLは、無効なアクセストークンを更新するためにもサーバーで使用されます。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| tokens_status | integer | トークンの状態を表すビットマスク。 指定可能な値: 0 - (デフォルト) 両方のトークンに無効な値が含まれる 1 - アクセストークンに有効な値が含まれる 2 - リフレッシュトークンに有効な値が含まれる 3 - 両方のトークンに有効な値が含まれる。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合に サポート |
| access_token | string | OAuthアクセストークンの値。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| access_token_updated | timestamp | refresh_token による更新時、またはトークン変更時にAPIによって、サーバーが access_token を最後に変更した時刻のタイムスタンプ。プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合に サポート |
| access_expires_in | integer | access_token が期限切れとなり、refresh_url へのリクエストが必要になるまでの秒数。Zabbixサーバーが access_token を更新した際、またはトークン変更時にAPIによって設定されます。タイムスタンプは access_token_updated の値を加算して計算されます。プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合に サポート |
| refresh_token | string | OAuthリフレッシュトークンの値。 プロパティの動作: - smtp_authentication が「OAuthトークン」に設定されている場合は 必須 |
| status | integer | メディアタイプが有効かどうか。 指定可能な値: 0 - (デフォルト) 有効; 1 - 無効。 |
| username | string | ユーザー名。 プロパティの動作: - smtp_authentication が「通常のパスワード」に設定されている場合に サポート |
| maxsessions | integer | 並列処理できるアラートの最大数。type が「SMS」に設定されている場合の指定可能な値: 1。type が「メール」、「スクリプト」、または「Webhook」に設定されている場合の指定可能な値: 0-100。デフォルト: 1。 |
| maxattempts | integer | アラート送信の最大試行回数。 指定可能な値: 1-100。 デフォルト: 3。 |
| attempt_interval | string | 再試行の間隔。 秒、およびサフィックス付きの時間単位を受け付けます。 指定可能な値: 0-1h。 デフォルト: 10s。 |
| message_format | integer | メッセージ形式。 指定可能な値: 0 - プレーンテキスト; 1 - (デフォルト) HTML。 プロパティの動作: - type が「メール」に設定されている場合に サポート |
| script | text | webhookスクリプト本体（JavaScript）。 プロパティの動作: - type が「Webhook」に設定されている場合は 必須 |
| timeout | string | webhookスクリプトのタイムアウト。 秒、およびサフィックス付きの時間単位を受け付けます。 指定可能な値: 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」または「スクリプト」に設定されている場合に サポート |
| description | text | メディアタイプの説明。 |
webhookパラメータ
webhookパラメータには以下のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| name | string | パラメータ名。 プロパティの動作: - 必須 |
| value | string | パラメータ値。マクロをサポートします。 サポートされるマクロについては、サポートされるマクロページを参照してください。 |
スクリプトパラメータ
スクリプトパラメータには以下のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| sortorder | integer | パラメータ値がコマンドライン引数としてスクリプトに渡される順序です。最初の引数は 0 から始まります。 プロパティの動作: - 必須 |
| value | string | パラメータ値です。マクロをサポートします。 サポートされるマクロについては、サポートされるマクロページを参照してください。 |
メッセージテンプレート
メッセージテンプレートオブジェクトは、通知を送信するためのアクションの実行時にデフォルトメッセージとして使用されるテンプレートを定義します。以下のプロパティがあります。