Tuning Manager APIリファレンスガイド

3.11.4 notice型

アラート機能のアクションを指定する型です。notice型の構造を示します。

{
    "noticeID":"<notice ID>",
    "emailNotification":"<noticesを発生させる契機>",
    "emails":[ <email型：emailアクション> ]
}

表3-22 notice型のスキーマ

変数名	型	指定要否	説明
noticeID	string	必須	任意のnotice ID targetとnoticeとtriggerの組み合わせをdefinitionsで指定する場合に使用します。 notice ID名は128バイト以内の次に示す文字で指定します。 半角英数字および# ( ) - @ _
emailNotification	string型の配列	任意	emailを送信する契機 warning，caution，またはnormalを指定できます。 複数選択できます。省略した場合，すべて指定しているとみなされます。推奨はすべての指定です。
emails	email型の配列	任意	emailアクションの設定 省略した場合は，定義なしと見なされます。 emailsで指定できるemailアクションの設定数は，3個以内です。

この項の構成

(1) email型

(1) email型

email型の構造を示します。

{
    "addresses":"<emailの宛先>",
    "subject":"<emailのタイトル>",
    "body":"<emailの本文>"
}

表3-23 email型のスキーマ

変数名	型	指定要否	説明
addresses	stringの配列	必須	emailの宛先 指定できる宛先の長さは256バイト以内，指定できる宛先の数は10個です。
subject	string	必須	emailのタイトル タイトルは300バイト以内の次に示す文字で指定します。 半角英数字および! # & ( ) * - . / : ; < = > ? @ _ |
body	string	必須	emailの本文 本文は1,000バイト以内の次に示す文字で指定します。 半角英数字，半角スペース，定義変数※，エスケープ文字※および! # & ( ) * - . / : ; < = > ? @ _ |

注※

定義変数およびエスケープ文字については「A.2.2 アラート定義情報を定義する際に使用できる文字について」を参照してください。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.