Sending a test error notification email

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request sends a test error notification email to verify that the settings related to the sending of email notifications for the service information messages (SIMs) of storage systems are correctly specified.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Storage Administrator (Initial Configuration)

Request line

POST base-URL/v1/objects/alert-email-settings/instance/actions/send-email-test/invoke

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query parameters
None.
Body
None.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects. affectedResources is not displayed for this API. To verify that the email was successfully sent, check whether the test email was received by the specified recipients (destination addresses).

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description of HTTP status codes.

Status code

Message

Description

412

Precondition Failed

If the setting for sending error notification emails is disabled, test emails cannot be sent.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/alert-email-settings/instance/actions/send-email-test/invoke -d ""