17.13 障害通知メールの設定をする
- メモ
-
REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。
実行権限
ストレージ管理者(初期設定)
リクエストライン
PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/alert-email-settings/instance
このAPIはPATCHメソッドでも実行できます。
リクエストメッセージ
- オブジェクトID
-
instanceを指定します。
instanceは、単一のインスタンスしか持たないオブジェクトの場合に、オブジェクトIDとして指定する固定の値です。
- クエリパラメータ
-
なし。
- ボディ
-
{ "isEmailNotificationEnabled": true, "mailServer": { "serverName": "server1", "smtpAuth" : { "account": "user1", "password": "userPass" } }, "fromAddress" : "from@example.com", "replyToAddress" : "reply@example.com", "toAddresses" : [ { "attribute" :"to", "address" :"to@example.com" }, { "attribute" :"cc", "address" :"cc@example.com" }, { "attribute" :"bcc", "address" :"bcc@example.com" } ], "description" : "description" }
属性
型
説明
isEmailNotificationEnabled
boolean
(任意)障害通知メールの送信を有効にするかどうか- true:有効にする
- false:無効にする
mailServer
object
(任意)メール送信サーバの設定
serverName(string)
(任意)メール送信サーバのIPアドレスまたはホスト名
障害通知メールの送信を有効にする場合は、必ずmailServerオブジェクト配下のserverName属性を指定してください。
IPv4、IPv6のIPアドレス、またはホスト名の形式で指定できます。
1~255文字で指定します。
ホスト名に使用できる文字は次のとおりです。- 半角英数字
-
半角記号
! $ % - . @ _ ` ~
メール送信サーバのIPアドレスまたはホスト名を削除する場合は、isEmailNotificationEnabled属性にfalseを指定して、この属性に空文字を指定します。
-
smtpAuth(object)
(任意)メール送信サーバのSMTP認証の設定
-
isSmtpAuthEnabled(boolean)
(任意)SMTP認証を使用するかどうか
・true:使用する
・false:使用しない
account(string)
(任意)SMTP認証のアカウント(ユーザ名)
isSmtpAuthEnabled属性にtrueを指定した場合、必ず指定します。
1~255文字で指定します。
使用できる文字は次のとおりです。
・半角英数字
・半角記号
! $ % ( ) - . @ _ ` ~
半角スペースは使用できません。
SMTP認証のアカウント(ユーザ名)を削除する場合は、isSmtpAuthEnabled属性にfalseを指定して、この属性に空文字を指定してください。
-
password(string)
(任意)SMTP認証のパスワード
isSmtpAuthEnabled属性にtrueを指定した場合、必ず指定します。
1~255文字で指定します。
使用できる文字は次のとおりです。
・半角英数字
・半角記号
! $ % ( ) - . @ _ ` ~
半角スペースは使用できません。
SMTP認証のパスワードを削除する場合は、isSmtpAuthEnabled属性にfalseを指定して、この属性に空文字を指定してください。
-
fromAddress
string
(任意)障害通知メールの送信元(from:)アドレス※
1~255文字で指定します。
障害通知メールの送信元(from:)アドレスを削除する場合は、isEmailNotificationEnabled属性にfalseを指定して、この属性に空文字を指定します。
replyToAddress
string
(任意)障害通知メールの返信先(reply-to:)アドレス※
1~255文字で指定します。
障害通知メールの返信先(reply-to:)アドレスを削除する場合、空文字を指定します。
toAddresses
object[]
(任意)障害通知メールの送信先アドレスの配列
最大で32個の障害通知メールの送信先アドレスを指定できます。この属性を指定した場合、既存の障害通知メールの送信先アドレスをすべて上書きします。
-
attribute(string)
障害通知メールの送信先アドレスの属性
toAddresses属性を指定する場合、必ず指定します。
- to
- cc
- bcc
-
address(string)
障害通知メールの送信先アドレス※
toAddresses属性を指定する場合、必ず指定します。1~255文字で指定します。
登録されている障害通知メールの送信先アドレスをすべて削除する場合は、isEmailNotificationEnabled属性にfalseを指定して、この属性に空の配列を指定します。
description
string
(任意)障害通知メールの本文先頭に表示する内容
通知する付加情報として、障害通知メールの本文先頭に出力する内容を、1~511文字で指定します。
使用できる文字は次のとおりです。-
半角英数字
-
半角記号
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
-
半角スペース
-
改行
改行は2文字としてカウントされます。
障害通知メールの本文先頭に表示する内容を削除する場合、空文字を指定します。
注※ メールの送信元(from:)アドレス、メールの返信先(reply-to:)アドレス、またはメールの送信先アドレスで使用できる文字は次のとおりです。- 半角英数字
-
次の半角記号
! # $ % & ' * + - . = ? @ ^ _ ` { | } ~
レスポンスメッセージ
- ボディ
-
ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。
属性
説明
affectedResources
障害通知メールの設定情報を取得するURL
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/886000123457/alert-email-settings/instance