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。

プロパティの動作:
- type が "Email" に設定されている場合に サポート
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。
content_type
(deprecated)		 integer このパラメータは非推奨です。代わりに message_format を使用してください。
メッセージ形式。

指定可能な値:
0 - Plain text;
1 - (デフォルト) HTML。

プロパティの動作:
- type が "Email" に設定されている場合に サポート
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パラメータには以下のプロパティがあります。

プロパティ 型 説明
name string パラメータ名。

プロパティの動作:
- 必須
value string パラメータ値。マクロをサポートします。
サポートされるマクロについては、サポートされるマクロページを参照してください。

スクリプトパラメータ

スクリプトパラメータには、以下のプロパティがあります。

プロパティ Type 説明
sortorder integer パラメータ値がコマンドライン引数としてスクリプトに渡される順序です。最初の引数は 0 から始まります。

プロパティの動作:
- 必須
value string パラメータ値です。マクロをサポートします。
サポートされるマクロについては、サポートされるマクロ ページを参照してください。

メッセージテンプレート

メッセージテンプレートオブジェクトは、通知を送信するためのアクションの実行時にデフォルトメッセージとして使用されるテンプレートを定義します。次のプロパティがあります。

プロパティ Type 説明
eventsource integer イベントソース。

使用可能な値:
0 - トリガー;
1 - ディスカバリ;
2 - 自動登録;
3 - 内部;
4 - サービス。

プロパティの動作:
- 必須
recovery integer 実行モード。

使用可能な値:
0 - 実行;
1 - 復旧時の実行;
2 - 更新時の実行。

プロパティの動作:
- 必須
subject string メッセージの件名。
message string メッセージ本文。