Configuring QoS settings for a volume

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 configures the QoS settings (such as the upper and lower limits on IOPS and on the amount of data that can be transferred, and the amount of time to wait before issuing related alerts) for a specified volume.
Note:
  • You can use QoS to control I/O between a host and the volumes of a storage system. You can configure QoS settings for volumes that are directly connected to the host.

Execution permission

Storage Administrator (System Resource Management)

Request line

POST base-URL/v1/objects/ldevs/object-ID/actions/set-qos/invoke

Request message

Object ID
Specify the value of ldevId that was obtained by the processing to get information about volumes.

Attribute

Type

Description

ldevId

int

(Required) Specify the LDEV number as a decimal (base 10) number.

Query parameters
None.
Body
{
    "parameters": {
        "upperIops": 100
    }
}

You can specify only one attribute each time you run this API request.

Attribute

Type

Description

upperIops

long

(Optional) Upper limit on the IOPS

Specify a value in the range from 100 to 2147483647. If the lowerIops attribute is set, the value specified for this attribute must be greater than the value of the lowerIops attribute.

To disable this setting, specify 0. If you disable both the upperIops attribute and the upperTransferRate attribute, the upperAlertAllowableTime attribute will also be disabled.

upperTransferRate

int

(Optional) Upper limit on the amount of data that can be transferred per second (in MB)

Specify a value in the range from 1 to 2097151. If the lowerTransferRate attribute is set, the value specified for this attribute must be greater than the value of the lowerTransferRate attribute.

To disable this setting, specify 0. If you disable both the upperIops attribute and the upperTransferRate attribute, the upperAlertAllowableTime attribute will also be disabled.

upperAlertAllowableTime

int

(Optional) Amount of time to wait before issuing an alert when the IOPS or the amount of data transferred per second exceeds the upper limit for a continuous period of time (in seconds)

Specify a value in the range from 1 to 600. You can specify this attribute only if one or both of the upperIops and upperTransferRate attributes are already set.

To disable this setting, specify 0.

lowerIops

long

(Optional) Lower limit on the IOPS

Specify a value in the range from 10 to 2147483647. If the upperIops attribute is set, the value specified for this attribute must be less than the value of the upperIops attribute.

To disable this setting, specify 0. If you disable both the lowerIops attribute and the lowerTransferRate attribute, the lowerAlertAllowableTime attribute will also be disabled.

You can specify this parameter if the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

lowerTransferRate

int

(Optional) Lower limit on the amount of data that can be transferred per second (in MB)

Specify a value in the range from 1 to 2097151. If the upperTransferRate attribute is set, the value specified for this attribute must be less than the value of the upperTransferRate attribute.

To disable this setting, specify 0. If you disable both the lowerIops attribute and the lowerTransferRate attribute, the lowerAlertAllowableTime attribute will also be disabled.

You can specify this parameter if the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

lowerAlertAllowableTime

int

(Optional) Amount of time to wait before issuing an alert when the IOPS or the amount of data transferred per second falls below the lower limit for a continuous period of time (in seconds)

Specify a value in the range from 1 to 600. You can specify this attribute only if one or both of the lowerIops and lowerTransferRate attributes are already set.

To disable this setting, specify 0.

You can specify this parameter if the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

responsePriority

int

(Optional) Priority level of the I/O processing

Specify a value in the range from 1 to 3. A larger value indicates a higher level of priority. If you specify this attribute, a target response time will be set, based on the priority level you set.

To disable this setting, specify 0. If you disable the responsePriority attribute, the responseAlertAllowableTime attribute will also be disabled.

You can specify this parameter if the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

responseAlertAllowableTime

int

(Optional) Amount of time to wait before issuing an alert when the response time exceeds the target response time for a continuous period of time (in seconds)

Specify a value in the range from 1 to 600.

To disable this setting, specify 0.

You can specify this parameter if the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the description of job objects.

Attribute

Description

affectedResources

URL of the LDEV for which QoS settings were configured

Action template

None.

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/ldevs/100/actions/set-qos/invoke