17.12　障害通知メールの設定情報を取得する : Hitachi Command Suite Configuration Manager REST API リファレンスガイド

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/alert-email-settings/instance

リクエストメッセージ

オブジェクトID

instanceを指定します。

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

クエリパラメータ: なし。

ボディ: なし。

レスポンスメッセージ

ボディ

{
  "isEmailNotificationEnabled" : true,
  "mailServer" : {
    "serverName" : "server1",
    "smtpAuth" : {
      "isSmtpAuthEnabled" : false,
      "account" : "user1",
      "password" : "****"
    }
  },
  "fromAddress" : "from@example.com",
  "replyToAddress" : "replyTo@example.com",
  "toAddresses" : [
   {
    "attribute" : "to",
    "address" : "to@example.com"
   } 
  ],
  "description" : "description"
}

属性	型	説明
isEmailNotificationEnabled	boolean	障害通知メールの通知が有効かどうか `true`：有効 `false`：無効
mailServer	object	メール送信サーバの設定障害通知メールのメール送信サーバについて、メール送信サーバのIPアドレスまたはホスト名と、SMTP認証の設定の情報が出力されます。 serverName（string）メール送信サーバのIPアドレスまたはホスト名 smtpAuth（object）メール送信サーバのSMTP認証の設定 isSmtpAuthEnabled（boolean） SMTP認証が有効かどうか・`true`：有効・`false`：無効 account（string） SMTP認証のアカウント（ユーザ名） password（string） SMTP認証のパスワード設定されている場合、`****`（4桁のアスタリスク）が出力されます。設定されていない場合、空文字が出力されます。
fromAddress	string	障害通知メールの送信元（from:）アドレス
replyToAddress	string	障害通知メールの返信先（reply-to:）アドレス
toAddresses	object[]	障害通知メールの送信先アドレスの配列障害通知メールの送信先アドレスが設定されている場合、次の情報が出力されます。 attribute（string）障害通知メールの送信先アドレスの属性 `to`、`cc`または`bcc`が出力されます。 address（string）障害通知メールの送信先アドレス
description	string	障害通知メールの本文先頭に表示する内容通知する付加情報として、障害通知メールの本文先頭に表示する内容が出力されます。

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/886000123457/alert-email-settings/instance

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

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