You can retrieve a list of active storage component alerts. Alerts are triggered by events and remain active until the condition that caused the event is removed. For example, HCP for cloud scale sends an alert when a storage component is unavailable or its certificate is about to expire. When the event is resolved, the alert is cleared.
HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/alert/list
Request structure
Not applicable.
Response structure
The response body is:
[ { "id": "uuid", "timestamp": date_time, "category": "STORAGECOMPONENT", "description": "alert_description" } . . . ]
Parameter |
Type |
Description |
---|---|---|
id | UUID | The ID of the storage component. |
timestamp | 64-bit integer | The date and time, in milliseconds since 00:00:00 on 1 January 1970 GMT, when the alert was generated. |
category | String | Alert category:
|
description | String | The text of the alert. |
Return codes
Status code |
HTTP name |
Description |
---|---|---|
200 | OK | The request was executed successfully. |
Example
Request example:
POST https://10.10.24.195:9099/mapi/v1/alert/list
JSON response:
[ { "id": "3fa85f64-1024-4562-b3fc-2c963f66afa6", "timestamp": 1571912640205, "category": "STORAGECOMPONENT", "description": "string" } ]