Documentation
Table of Contents
> Media typeオブジェクト
次のオブジェクトは、mediatypeAPIに直接関連しています。
Media type
media typeオブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| mediatypeid | string | (読取専用)メディアタイプのID |
| name (必須) |
string | メディアタイプ名 |
| type (必須) |
integer | メディアタイプで使用される送信方法。 可能な値: 0 - 電子メール 1 - スクリプト 2 - SMS 4 - Webhook |
| exec_path | string | スクリプトメディアタイプの場合exec_pathには実行されたスクリプトの名前が含まれます。スクリプトメディアタイプで使用されます |
| gsm_modem | string | GSMモデムのシリアルデバイス名。 SMSメディアタイプで使用されます |
| passwd | string | 認証パスワード 電子メールメディアタイプで使用されます |
| smtp_email | string | 通知の送信元の電子メールアドレス。 電子メールメディアタイプで使用されます |
| smtp_helo | string | SMTP HELO. 電子メールメディアタイプで使用されます |
| smtp_server | string | SMTP サーバ 電子メールメディアタイプで使用されます |
| smtp_port | integer | SMTP サーバ接続ポート |
| smtp_security | integer | SMTP接続のセキュリティレベル。 利用可能な値: 0 - なし 1 - STARTTLS 2 - SSL/TLS |
| smtp_verify_host | integer | SMTPのSSLホスト検証 利用可能な値: 0 - いいえ 1 - はい |
| smtp_verify_peer | integer | SMTPのSSLピア検証 利用可能な値: 0 - いいえ 1 - はい |
| smtp_authentication | integer | SMTP認証方法 利用可能な値: 0 - なし 1 - 通常のパスワード |
| status | integer | メディアタイプの有効無効 利用可能な値: 0 - (デフォルト)有効 1 - 無効 |
| username | string | ユーザー名 電子メールメディアタイプで使用されます。 |
| exec_params | string | スクリプトパラメータ 各パラメータは改行で終わります |
| maxsessions | integer | 並行して処理できるアラートの最大数 SMSで利用可能な値: 1 - (デフォルト) 他のメディアタイプで利用可能な値: 0-100 |
| maxattempts | integer | アラート送信の最大試行回数 可能な値: 1-100 デフォルト値: 3 |
| attempt_interval | string | 再試行の間隔。 接尾辞付きの秒と時間の単位を受け入れます。 可能な値: 0-1h デフォルト値: 10s |
| content_type | integer | メッセージフォーマット 可能な値: 0 - プレーンテキスト 1 - (デフォルト)html |
| script | string | メディアタイプwebhookスクリプトjavascript本体 |
| timeout | string | メディアタイプのwebhookスクリプトのタイムアウト。 接尾辞付きの秒と時間の単位を受け入れます。 利用可能な値: 1-60s デフォルト値: 30s |
| process_tags | integer | Webhookスクリプトの応答をタグとして解釈し、これらのタグを関連するイベントに追加する必要があるかどうかを定義します。 可能な値: 0 - (デフォルト)Webhookスクリプトの応答を無視します 1 - Webhookスクリプトの応答をタグとして処理します |
| show_event_menu | integer | problem.getおよびevent.getプロパティurlsにメディアタイプエントリを表示します。利用可能な値: 0 - (デフォルト) urlsエントリを追加しない<br >1 - メディアタイプをurlsプロパティに追加する |
| event_menu_url | string | メディアタイプエントリのurlプロパティをproblem.getとevent.getのurlsプロパティに定義します。 |
| event_menu_name | string | メディアタイプエントリのnameプロパティをproblem.getとevent.getのurlsプロパティに定義します。 |
| parameters | array | webhook入力パラメーターの配列 |
| description | string | メディアタイプの説明 |
Webhook parameters
Webhookスクリプトが呼び出されたときに渡されるパラメーターには、次のプロパティがあります。
Script parameters
Parameters passed to a script when it is being called have the following properties.
| Property | Type | Description |
|---|---|---|
| sortorder (required) |
integer | The order in which the parameters will be passed to the script as command-line arguments. Starting with 0 as the first one. |
| value | string | Parameter value, supports macros. Supported macros are described on the Supported macros page. |
Message template
message template オブジェクトは、通知を送信するためのアクション操作のデフォルトメッセージとして使用されるテンプレートを定義します。 以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| eventsource (必須) |
integer | イベントソース 利用可能な値: 0 - トリガー 1 - ディスカバリ 2 - 自動登録 3 - インターナル 4 - サービス |
| recovery (必須) |
integer | オペレーションモード 可能な値: 0 - 操作 1 - 回復操作 2 - 更新操作 |
| subject | string | メッセージの件名 |
| message | string | メッセージテキスト |