Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


17.14 障害通知メールの送信先アドレスを追加する

ストレージシステムの障害情報(SIM)をメールで通知するための障害通知メールの送信先アドレスを追加します。このAPIでは、障害通知メールの送信先アドレスを1つずつ追加します。
メモ

REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。

実行権限

ストレージ管理者(初期設定)

リクエストライン

PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/alert-email-settings/instance/actions/add-recipient-address/invoke

このAPIはPOSTメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

instanceを指定します。

instanceは、単一のインスタンスしか持たないオブジェクトの場合に、オブジェクトIDとして指定する固定の値です。

クエリパラメータ

なし。

ボディ
{
     "parameters": {
        "attribute" : "to",
        "address"   : "to@example.com"
     }
}

属性

説明

attribute

string

(必須)追加する障害通知メールの送信先アドレスの属性

  • to
  • cc
  • bcc

address

string

(必須)追加する障害通知メールの送信先アドレス

1~255文字で指定します。

使用できる文字は次のとおりです。
  • 半角英数字
  • 次の半角記号

    ! # $ % & ' * + - . = ? @ ^ _ ` { | } ~

スペースは使用できません。

レスポンスメッセージ

ボディ

ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。

属性

説明

affectedResources

障害通知メールの設定情報を取得するURL

Actionテンプレート

なし。

ステータスコード

この操作のリクエストに対するステータスコードについては、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/actions/add-recipient-address/invoke