Getting information about the QoS settings of a specific volume

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/volumes/object-ID/qos-setting

Request message

Object ID

Specify the id value obtained by getting information about volumes.

Attribute	Type	Description
id	int	(Required) Volume ID

Query parameters

None.

Body

None.

Response message

Body

The following is an example of getting information about the QoS settings of a volume with a volume ID of 100:

{
    "volumeId": 100,
    "threshold": {
        "isUpperIopsEnabled": true,
        "upperIops": 2000,
        "isUpperTransferRateEnabled": true,
        "upperTransferRate": 20000,
        "isLowerIopsEnabled": true,
        "lowerIops": 1000,
        "isLowerTransferRateEnabled": true,
        "lowerTransferRate": 10000,
        "isResponsePriorityEnabled": false
    },
    "alertSetting": {
        "isUpperAlertEnabled": true,
        "upperAlertAllowableTime": 10,
        "isLowerAlertEnabled": true,
        "lowerAlertAllowableTime": 20,
        "isResponseAlertEnabled": false
    },
    "alertTime": {}
}

Attribute	Type	Description
volumeId	int	Volume ID
threshold	object	Information about the QoS settings of the volume: isUpperIopsEnabled (boolean) Whether the upper limit on the IOPS is enabled true: Enabled false: Disabled upperIops (int) Upper limit on the IOPS This attribute appears if true is set for isUpperIopsEnabled. 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 (MiBps) This attribute appears if true is set for isUpperTransferRateEnabled. isLowerIopsEnabled (boolean) Whether the lower limit on the IOPS is enabled true: Enabled false: Disabled lowerIops (int) Lower limit on the IOPS This attribute appears if true is set for isLowerIopsEnabled. isLowerTransferRateEnabled (boolean) Whether the lower limit on the amount of data that can be transferred is enabled true: Enabled false: Disabled lowerTransferRate (int) Lower limit on the amount of data that can be transferred (MiBps) This attribute appears if true is set for isLowerTransferRateEnabled. isResponsePriorityEnabled (boolean) Whether the priority level of the I/O processing is enabled true: Enabled false: Disabled responsePriority (string) Priority level of the I/O processing A larger value indicates a higher level of priority, and a smaller value indicates a lower level of priority. This attribute appears if true is set for isResponsePriorityEnabled. targetResponseTime (int) Target response time (msec) This attribute appears if true is set for isResponsePriorityEnabled.
alertSetting	object	Information about the alert settings of the volume: 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 attribute appears if true is set for isUpperAlertEnabled. isLowerAlertEnabled (boolean) Whether alerts are output if the IOPS or the amount of data transferred falls below the lower limit for a continuous period of time true: Output false: Not output lowerAlertAllowableTime (int) Amount of time to wait before issuing an alert when a lower limit is not met for a continuous period of time (in seconds) This attribute appears if true is set for isLowerAlertEnabled. isResponseAlertEnabled (boolean) Whether alerts are output if the average response time not achieve the target response time for a continuous period of time true: Output false: Not output responseAlertAllowableTime (int) Amount of time to wait before issuing an alert when the average response time not achieve the target response time (in seconds) This attribute appears if true is set for isResponseAlertEnabled.
alertTime	object	Information about the times# when alerts were issued for the volume appears. 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) This attribute does not appear if the setting to issue alerts is not configured or if no alerts have been issued. lowerAlertTime (ISO8601string) Time when the last alert was issued because the IOPS or the amount of data transferred per second had fallen below the lower limit for a continuous period of time (UTC) This attribute does not appear if the setting to issue alerts is not configured or if no alerts have been issued. responseAlertTime (ISO8601string) Time when the last alert was issued because the average response time had exceeded the target response time for a continuous period of time (UTC) This attribute does not appear if the setting to issue alerts is not configured or if no alerts have been issued.

#

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

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/volumes/100/qos-setting