Media typeオブジェクト
次のオブジェクトは、mediatypeAPIに直接関連しています。
メディアタイプ
メディアタイプオブジェクトには、以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| mediatypeid | ID | メディアタイプのID。 プロパティの動作: - 読み取り専用 - 更新操作では 必須 |
| name | string | メディアタイプの名前。 プロパティの動作: - 作成操作では 必須 |
| type | integer | メディアタイプで使用される転送方式。 指定可能な値: 0 - Email; 1 - Script; 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 - (デフォルト) Generic SMTP; 1 - Gmail; 2 - Gmail relay; 3 - Office365; 4 - Office365 relay. |
| 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 - (デフォルト) None; 1 - STARTTLS; 2 - SSL/TLS. プロパティの動作: - type が "Email" に設定されている場合に サポート |
| smtp_verify_host | integer | SMTP用のSSLホスト検証。 指定可能な値: 0 - (デフォルト) No; 1 - Yes. プロパティの動作: - smtp_security が "STARTTLS" または "SSL/TLS" に設定されている場合に サポート |
| smtp_verify_peer | integer | SMTP用のSSLピア検証。 指定可能な値: 0 - (デフォルト) No; 1 - Yes. プロパティの動作: - smtp_security が "STARTTLS" または "SSL/TLS" に設定されている場合に サポート |
| smtp_authentication | integer | 使用するSMTP認証方式。 指定可能な値: 0 - (デフォルト) None; 1 - Normal password; 2 - OAuth token. Office365 relay メールプロバイダーでは OAuth 認証は使用できません。 プロパティの動作: - type が "Email" に設定されている場合に サポート |
| redirection_url | string | OAuth 認可を戻すための Zabbix Webインターフェース URL。 デフォルト: API settings プロパティ url の値に zabbix.php?action=oauth.authorize の部分を付加したものプロパティの動作: - smtp_authentication が "OAuth token" に設定されている場合は 必須 |
| client_id | string | OAuth 認可サーバー内に登録されたクライアント識別子。 プロパティの動作: - smtp_authentication が "OAuth token" に設定されている場合は 必須 |
| client_secret | string | OAuth 認可サーバー内に登録されたクライアントシークレット。Super Admin タイプのユーザーのみアクセスできます。 プロパティの動作: - 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 - (default) 両方のトークンに無効な値が含まれる 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 へのリクエストが必要になるまでの秒数。Zabbix サーバーが access_token を更新した際、または API がトークン変更時に設定します。タイムスタンプは access_token_updated の値を加算して計算されます。プロパティの動作: - smtp_authentication が "OAuth token" に設定されている場合に サポート |
| refresh_token | string | OAuth リフレッシュトークンの値。 プロパティの動作: - smtp_authentication が "OAuth token" に設定されている場合は 必須 |
| status | integer | メディアタイプが有効かどうか。 指定可能な値: 0 - (デフォルト) Enabled; 1 - Disabled. |
| 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 | 再試行の間隔。 秒、およびサフィックス付きの時間単位を受け付けます。 指定可能な値: 0-1h。 デフォルト: 10s。 |
| message_format | integer | メッセージ形式。 指定可能な値: 0 - Plain text; 1 - (デフォルト) HTML. プロパティの動作: - type が "Email" に設定されている場合に サポート |
| 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 が "Include event menu entry and urls property" に設定されている場合に サポート |
| event_menu_name | string | イベントメニュー のエントリ、および problem.get と event.get が返す urls プロパティで使用される名前。プロパティの動作: - show_event_menu が "Include event menu entry and urls property" に設定されている場合に サポート |
| parameters | array | Webhook または スクリプト のパラメータ。 プロパティの動作: - type が "Webhook" または "Script" に設定されている場合に サポート |
| description | text | メディアタイプの説明。 |
webhookパラメータ
webhookパラメータには、以下のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| name | string | パラメータ名。 プロパティの動作: - 必須 |
| value | string | パラメータ値。マクロをサポートします。 サポートされるマクロについては、サポートされるマクロページで説明されています。 |
スクリプトパラメータ
スクリプトパラメータには、以下のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| sortorder | integer | パラメータ値がコマンドライン引数としてスクリプトに渡される順序です。最初の引数は 0 から始まります。 プロパティの動作: - 必須 |
| value | string | パラメータ値です。マクロをサポートします。 サポートされるマクロについては、サポートされるマクロ ページを参照してください。 |
メッセージテンプレート
メッセージテンプレートオブジェクトは、通知を送信するためのアクションの実行時にデフォルトメッセージとして使用されるテンプレートを定義します。次のプロパティがあります。