Getting information for a specific QoS group

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
This request gets information about QoS group.
Note:

This API request can be used when the storage system is VSP 5000 series.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/qos-groups/object-ID

Request message

Object ID

Specify the value of id that is obtained when you get information about the QoS group.

Attribute

Type

Description

id

int

(Required) ID of the QoS group

Query parameters

Parameter

Type

Description

withVolumeIds

boolean

(Optional) Specify whether to get information about the LDEV numbers that belong to the QoS group.

  • true: Obtain the LDEV numbers.
  • false: Do not obtain the LDEV numbers.

If this value is omitted, false is assumed.

Body

None.

Response message

Body
{
    "id": 200,
    "threshold": {
        "isUpperIopsEnabled": true,
        "upperIops": 2000,
        "isUpperTransferRateEnabled": true,
        "upperTransferRate": 20000
    },
    "alertSetting": {
        "isUpperAlertEnabled":  true,
        "upperAlertAllowableTime": 10
    },
    "alertTime": {
        "upperAlertTime": "2020-10-21T07:10:17Z"
    },
    "volumeIds": [
        10000,
        10001
    ]
}

Attribute

Type

Description

id

int

ID of the QoS group

threshold

object

Information about the QoS settings of the QoS group

  • isUpperIopsEnabled (boolean)

    Whether the upper limit on the IOPS is enabled:

    • true: Enabled
    • false: Disabled
  • upperIops (int)

    Upper limit on the IOPS

    This information is not output if isUpperIopsEnabled is false.

  • isUpperTransferRateEnabled (boolean)

    Whether the upper limit on the amount of data that can be transferred is enabled:

    • true: Enabled
    • false: Disabled
  • upperTransferRate (int)

    Upper limit on the amount of data that can be transferred per second (MBps)

    This information is not output if isUpperTransferRateEnabled is false.

alertSetting

object

Information about the alert settings of the QoS group

  • isUpperAlertEnabled (boolean)

    Whether alerts are output if the IOPS or the amount of data transferred not achieve the upper limit for a continuous period of time:

    • true: Output
    • false: Not output
  • upperAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when an upper limit is exceeded for a continuous period of time (in seconds)

    This information is not output if isUpperAlertEnabled is false.

alertTime

object

The time# when an alert was issued for the QoS group

  • upperAlertTime (ISO8601string)

    Time when the last alert was issued because the IOPS or the amount of data transferred per second had exceeded the upper limit for a continuous period of time (UTC)

volumeIds

int[]

The LDEV numbers that belong to the QoS group

This attribute is displayed only if you specified true for withVolumeIds in the query parameters.

#: If you change the time zone of the storage system, the times displayed for alerts that were issued before the change will be invalid.

Status codes

For details on the status codes of the API, see the description on 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/simple/v1/objects/qos-groups/200?withVolumeIds=true