Table of Contents
Media typeオブジェクト
次のオブジェクトは、mediatypeAPIに直接関連しています。
メディアタイプ
メディアタイプオブジェクトには以下のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| 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 - (デフォルト) なし; 1 - STARTTLS; 2 - SSL/TLS。 プロパティの動作: - typeが"Email"に設定されている場合はサポート |
| smtp_verify_host | integer | SMTPのSSL verify host。 可能な値: 0 - (デフォルト) いいえ; 1 - はい。 プロパティの動作: - smtp_securityが"STARTTLS"または"SSL/TLS"に設定されている場合はサポート |
| smtp_verify_peer | integer | SMTPのSSL verify peer。 可能な値: 0 - (デフォルト) いいえ; 1 - はい。 プロパティの動作: - smtp_securityが"STARTTLS"または"SSL/TLS"に設定されている場合はサポート |
| smtp_authentication | integer | 使用するSMTP認証方式。 可能な値: 0 - (デフォルト) なし; 1 - Normal password; 2 - OAuth token。 OAuth認証はOffice365 relayメールプロバイダーでは許可されていません。 プロパティの動作: - typeが"Email"に設定されている場合はサポート |
| redirection_url | string | OAuth認証後にリダイレクトするZabbixフロントエンドのURL。 デフォルト: API設定プロパティ 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 - (デフォルト) 両方のトークンが無効な値を含む 1 - アクセストークンが有効な値を含む 2 - リフレッシュトークンが有効な値を含む 3 - 両方のトークンが有効な値を含む。 プロパティの動作: - smtp_authenticationが"OAuth token"に設定されている場合はサポート |
| access_token | string | OAuthアクセストークンの値。 プロパティの動作: - smtp_authenticationが"OAuth token"に設定されている場合は必須 |
| access_token_updated | timestamp | access_tokenがサーバーによってrefresh_tokenでリフレッシュされた、またはAPIでトークンが変更された際の最終更新タイムスタンプ。プロパティの動作: - smtp_authenticationが"OAuth token"に設定されている場合はサポート |
| access_expires_in | integer | access_tokenが期限切れとなり、refresh_urlへのリクエストが必要になるまでの秒数。access_tokenのリフレッシュ時やAPIでトークンが変更された際にZabbixサーバーによって設定されます。タイムスタンプは 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 | 再試行間隔。 秒数またはサフィックス付きの時間単位を受け付けます。 可能な値: 0-1h。 デフォルト: 10s。 |
| message_format | integer | メッセージフォーマット。 可能な値: 0 - プレーンテキスト; 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が"イベントメニューエントリおよびurlsプロパティを含める"に設定されている場合はサポート |
| event_menu_name | string | イベントメニューエントリおよびproblem.get、event.getで返されるurlsプロパティで使用される名前。プロパティの動作: - show_event_menuが"イベントメニューエントリおよびurlsプロパティを含める"に設定されている場合はサポート |
| parameters | array | Webhookまたはスクリプトのパラメータ。 プロパティの動作: - typeが"Webhook"または"Script"に設定されている場合はサポート |
| description | text | メディアタイプの説明。 |
Webhookパラメータ
Webhookパラメータには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name | string | パラメータ名。 プロパティの動作: - 必須 |
| value | string | パラメータ値。マクロをサポート。 サポートされているマクロはサポートされているマクロページに記載されています。 |
スクリプトパラメータ
スクリプトパラメータには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| sortorder | 整数 | パラメータ値がコマンドライン引数としてスクリプトに渡される順序。先頭は0です。 プロパティの動作: - 必須 |
| 値 | 文字列 | パラメータ値。マクロをサポートします。 サポートされているマクロについては、サポートされているマクロページで説明されています。 |
メッセージテンプレート
メッセージテンプレートオブジェクトは、通知を送信するためのアクション操作のデフォルトメッセージとして使用されるテンプレートを定義します。以下のプロパティがあります。