Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Monitoring storage systems

You can monitor the status of storage systems by getting alerts (SIMs) generated on each storage system, as well as information about the power consumption and temperature of each storage system.

Getting a list of alert information

The following request gets a list of alerts related to the error information (SIM) of a storage system.

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

    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"

Getting information about the power consumption and temperature of a storage system

The following request gets information about the power consumed by a storage system and the controller's current temperature.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/components/instance
Request message
  • Object ID

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

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
        "system": {
            "powerConsumption": 332
        },
        "ctls": [
            {
                "location": "CTL1",
                "status": "Normal",
                "temperature": 19
            },
            {
                "location": "CTL2",
                "status": "Normal",
                "temperature": 19
            }
        ]
    }

    Attribute

    Type

    Description

    system

    object

    The following attribute related to the storage system information is output:

    • powerConsumption (int)

      Power consumption of the storage system (Watt)

      A value is output indicating the average amount of power consumed by the controller and the drive box per minute.

      If a valid value cannot be obtained, -1 is output.

    ctls

    object[]

    The following attributes related to the controller information are output:

    • location (string)

      Location of the controller

    • status (string)

      Status of the controller

      • Normal
      • Warning
      • Blocked
      • Failed
    • temperature (int)

      Temperature of the controller (°C)

      A value in the range from -55 to 125 is output.

      If a value outside of this range is obtained, -274 is output.

      If the value of the status attribute is Blocked, the value that was obtained immediately before the controller was blocked is output.#

    #: A similar value might also be output if the value of the status attribute is Failed.

Status codes

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

Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/components/instance