Getting a list of alert information

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 gets a list of alerts related to the error information (SIM) of a storage system.
Note:

This API request can be used when the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

Execution permission

Support Personnel or User Maintenance

Request line

GET base-URL/v1/objects/alerts

Request message

Object ID

None.

Query parameters

Attribute

Type

Filter Condition

type

string

(Required) Specify the type of the alert information you want to obtain.

Specifiable values are as follows:

  • DKC: DKC

  • CTL1: controller 1

  • CTL2: controller 2

start

int

(Optional) Specify the number of the alert from which you want to start obtaining information.

Alerts are sorted by date and time in descending order.

If you specified DKC for the type parameter, specify a value in the range from 1 to 10240.

If you specified CTL1 or CTL2 for the type parameter, specify a value in the range from 1 to 256.

If this parameter is omitted, alert information will be obtained starting from the first alert.

count

int

(Optional) Specify the number of alerts to be obtained.

If you specified DKC for the type parameter, specify a value in the range from 1 to 10240.

If you specified CTL1 or CTL2 for the type parameter, specify a value in the range from 1 to 256.

If this parameter is omitted, 10 alerts will be obtained.

Body

None.

Response message

Body
{
    "data" : [
        {
            "alertIndex" : "133ed620e449-0f0c9-7d0700",
            "alertId" : 61641,
            "occurenceTime" : "2018-03-22T16:14:01",
            "referenceCode" : 8193792,
            "errorLevel" : "Moderate",
            "errorSection" : "GUM detection error",
            "errorDetail" : "GUM security error detected",
            "location" : "CTL1",
            "actionCodes" : [
                {
                    "actionCode" : 1492123648,
                    "possibleFailureParts" : "TSC CALL",
                    "accLocation" : "-"
                }
            ]
        },
        {
            "alertIndex" : "133ed620a156-0f0c6-7d0700",
            "alertId" : 61638,
            "occurenceTime" : "2018-03-22T11:28:22",
            "referenceCode" : 8193792,
            "errorLevel" : "Moderate",
            "errorSection" : "GUM detection error",
            "errorDetail" : "GUM security error detected",
            "location" : "CTL1",
            "actionCodes" : [
                {
                    "actionCode" : 1492123648,
                    "possibleFailureParts" : "TSC CALL",
                    "accLocation" : "-"
                }
            ]
        },
        {
            "alertIndex" : "133ed6011907-0f0c3-7d0700",
            "alertId" : 61635,
            "occurenceTime" : "2018-03-20T19:59:03",
            "referenceCode" : 8193792,
            "errorLevel" : "Moderate",
            "errorSection" : "GUM detection error",
            "errorDetail" : "GUM security error detected",
            "location" : "CTL1",
            "actionCodes" : [
                {
                    "actionCode" : 1492123648,
                    "possibleFailureParts" : "TSC CALL",
                    "accLocation" : "-"
                }
            ]
        },
        {
            "alertIndex" : "133ed601164f-0f0bd-7d0700",
            "alertId" : 61629,
            "occurenceTime" : "2018-03-20T19:47:27",
            "referenceCode" : 8193792,
            "errorLevel" : "Moderate",
            "errorSection" : "GUM detection error",
            "errorDetail" : "GUM security error detected",
            "location" : "CTL1",
            "actionCodes" : [
                {
                    "actionCode" : 1492123648,
                    "possibleFailureParts" : "TSC CALL",
                    "accLocation" : "-"
                }
            ]
        }
    ]
}

Attribute

Type

Description

alertIndex

string

Character string that uniquely identifies an alert

alertID

int

Alert ID

The log number of the SIM is displayed.

occurenceTime

string

Date and time when the alert occurred

The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ss format.

referenceCode

int

SIM reference code (in decimal number format)

For details about SIM reference codes, see the SIM Reference Guide.

When you refer to the SIM Reference Guide, convert the reference code you obtained from the REST API into a hexadecimal number.

errorLevel

string

One of the following values is displayed as the error level:

  • Service: Service

  • Moderate: Warning (Moderate)

  • Serious: Error (Serious)

  • Acute: Acute

errorSection

string

Information about where the alert occurred

errorDetail

string

Details of the alert

location

string

The location of the component or part for which the error occurred

actionCodes

object[]

The following information related to the action code of the alert is displayed:

  • actionCode (long)

    Action code

  • possibleFailureParts (string)

    The part that might have been the cause of the error

    The name of the part that is assumed to be the cause of the error is displayed.

  • accLocation (string)

    Location

    The location of the component in which the error occurred is displayed.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session f76884c29fff4dfaa664aa6981087b71" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/alerts?type=CTL1&start=2&count=4"