Getting the operating status of snapshots and pools

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request gets status information about pools and snapshots, and enables you to check the operating status of storage resources.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/health-status

Request message

Object ID
None.
Query parameters
None.
Body
None.

Response message

Body
{
  "poolStatus":{
    "summary":"PartiallyBlocked",
    "abnormalItems":[
      {
        "status":"PartiallyBlocked",
        "poolIds":[
          0
        ]
      },
      {
        "status":"ExceededThreshold",
        "poolIds":[
          0,77,39,26
        ]
      }
    ]
  },
  "snapshotStatus":{
    "summary":"Normal"
  }
}

Attribute

Type

Description

poolStatus

object

Status of the pool:

  • summary (string)
    • Normal: All pools are normal.
    • ExceededThreshold: There is at least one pool where usage rate exceeds the threshold value.
    • PartiallyBlocked: There is at least one pool where some of the volumes that make up the pool are blocked.
    • Error: At least one pool is in the error status because it is full.
  • abnormalItems (object[])

    Information about abnormal pools:

    • status (string)

      - PartiallyBlocked: Some of the volumes that make up the pool are blocked.

      - ExceededThreshold: The pools where usage rate exceeds the threshold value.

      - Error: The pools that are in the error status because they are full.

    • poolIds (int[])

      Pool ID

snapshotStatus

object

Status of the snapshot:

  • summary (string)
    • Normal: All snapshots are normal.
    • Error: There is at least one snapshot where an error occurred.
  • abnormalItems (object[])

    Information about abnormal snapshots:

    • status (string)

      - Error: Snapshots where an error occurred.

    • masterVolumeIds (int[])

      Master volume ID of the snapshot

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/health-status