Call Home:Send Alert

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Send Alert

POST /vdc/callhome/alert/

Creates and sends an alert event with error logs attached as an aid to troubleshooting customer issues.

Query Parameters

event_id	Event id for these alerts Allowed values: 999, 599 Default: 999

Required Roles

SYSTEM_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

ConnectEMC should be configured and system should be licensed

Request Payload

<event_create>
   <user_str></user_str>
   <contact></contact>
   <namespace></namespace>
   <channel></channel>
   <severity></severity>
</event_create>

{
  "user_str": "",
  "contact": "",
  "namespace": "",
  "channel": "",
  "severity": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
event_create
user_str	User written string	String
contact	Contact details	String
namespace	namespace	String
channel	Alert channel. Allowed values: EMC, CUSTOMER, BOTH, NONE	String
severity	Alert severity. Allowed values: CRITICAL, ERROR, WARNING, INFO	String

Response Body

Alert response to sent this alert to ConnectEMC

Field	Description	Type	Notes
alert
id	Event id	String
type	alert type	String
severity	alert severity	String
timestamp	Event creating time of yyyy-MM-dd'T'HH:mm:ss format.	String
namespace	Namespace for this event	String
description	Description for this alert	String
symptomCode	Symptom Code	String
acknowledged	acknowledgement state of alert	Boolean

Examples

Request

POST https://192.168.0.0:4443/vdc/callhome/alert HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<event_create>
   <user_str>str</user_str>
   <contact>contact</contact>
</event_create>

Response

HTTP/1.1 200 OK 
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert>
    <id>urn:storageos:Alert:96a47d83-42c0-4b7f-bcab-958485b4b81d</id>
</alert>

Request

POST https://192.168.0.0:4443/vdc/callhome/alert.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
  "user_str": "str",
  "contact": "contact"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json 

{
    "id": "urn:storageos:Alert:4994aa60-2f2a-44e4-9314-56e0f67eab3f"
}