Getting the parameters used to configure Storage I/O control settings

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

The following operation is the initial step to configure Storage I/O control settings.

Execution permission

StorageOps

Request line

GET baseURL/v1/services/IoControlSettings/actions/submit

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the action.
href	string	URL for the action.
method	string	Name of the method.
type	string	Data format for the object.
parameters	anyType[]	A list of IoControlSettingParam objects necessary to execute an operation. For details, see the table below.

IoControlSettingParam

{
        "taskName":"...",
        "description":"...",
        "targetMetric":"...",
        "targetVolumes":["...", ...],
        "limitationMode":"...",
        "limitValue":"..."
}

IoControlSettingParam (Type: IoControlSettingParam)

Attribute	Type	Description
taskName	string	Name of the I/O control settings task
description	string	Explanation of the I/O control settings task
targetMetric	enum	Type of the target metric (For details about the valid values, see the table IoControlMetricType in List of enumerators.)
targetVolumes	string[]	ID of the target volume
limitationMode	enum	Upper limit setting mode (For details about the valid values, see the table LimitationMode in List of enumerators.)
limitValue	integer	Upper limit. Not used if limitationMode is "OFF". When targetMetric is "TransferRate", the unit is MBps.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/services/IoControlSettings/actions/submit HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 05 Sep 2016 03:18:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ed36ffc15b137a3d5a97dec11e134bc73b8fb4b_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json


[Response Body]
{
  "name" : "submit",
  "href" : "http://localhost:22015/Analytics/v1/services/IoControlSettings/actions/submit/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "taskName" : "taskName",
    "description" : "taskDescription",
    "targetMetric" : "IOPS",
    "targetVolumes" : [ "0" ],
    "limitationMode" : "ON",
    "limitValue" : 1
  } ]
}