Configuring Storage I/O control settings

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can configure Storage I/O control settings. Task IDs generated during the configuration task are returned as response data.

Execution permission

StorageOps

Request line

POST baseURL/v1/services/IoControlSettings/actions/submit/invoke

Request body

The structure of the request body and the object attributes are 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.

Response body

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	ID of the Instance.
created	string	Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
updated	string	Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
completed	string	Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
state	string	One of the following values is set: "failed": The operation failed. "success": The operation completed successfully.
affectedResource	string[]	A blank space is set.
result	anyType[]	A list of InstanceID objects. For details, see the table below.

InstanceID

{
        "instanceID":"..."
}

InstanceID (Type: InstanceID)

Attribute	Type	Description
instanceID	string	ID of the Instance.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	The format of the request body is invalid.
401	Unauthorized	No login privilege.
403	Forbidden	No execute privilege.
409	Conflict	A resource with the same task name exists.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

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

[Request Body]
{
  "name" : "submit",
  "href" : "http://localhost:22015/Analytics/v1/services/IoControlSettings/actions/submit/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters": [
    {
      "taskName": "taskName001122",
      "description": "taskDescription",
      "targetMetric": "IOPS",
      "targetVolumes": [
        "raidLdev#10182-00^FE^F5"
      ],
      "limitationMode": "ON",
      "limitValue": 1
    }
  ]
}

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


[Response Body]
{
  "instanceID" : "8a25cc50-b220-4285-bf6a-6fc71a3b3c78",
  "created" : "2016-09-05T12:39:10.625+09:00",
  "updated" : "2016-09-05T12:39:10.626+09:00",
  "completed" : "2016-09-05T12:39:10.626+09:00",
  "state" : "success",
  "affectedResource" : [ "http://localhost:22015/Analytics/v1/objects/IoControlHistory/iaaIoControlTask%23eda080ec%2dd675%2d4af6%2d95f6%2dabd5bf557ecb" ],
  "result" : [ {
    "instanceID" : "iaaIoControlTask#eda080ec-d675-4af6-95f6-abd5bf557ecb"
  } ]
}