Getting a list of tasks related to Storage I/O control settings

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of Storage I/O control configuration tasks and task-related information, such as names, descriptions, and statuses.

Execution permission

Admin, StorageOps, Modify

Request line

GET baseURL/v1/objects/IoControlHistory

Request body

Not applicable.

Response body

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of IoControlHistory objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

IoControlHistory

{
        "instanceID":"...",
        "taskName":"...",
        "description":"...",
        "targetMetric":"...",
        "targetVolumes":["...", ...],
        "limitationMode":"...",
        "limitValue":"...",
        "status":"...",
        "statusLastUpdateDateTime":,
        "registeredDatetime":,
        "registeredUserName":"...",
        "executionType":"...",
        "automationDirectorTaskIDs":["...", ...]
}

IoControlHistory (Type: IoControlHistory)

Attribute	Type	Description
instanceID	string	ID of the I/O control settings task.
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	long	Upper limit. Not used if limitationMode is "OFF". When targetMetric is "TransferRate", the unit is MBps.
status	enum	Task status. (For details about the valid values, see the table TaskStatus in List of enumerators.)
statusLastUpdateDateTime	datetime	Date and time when the task status was last obtained.
registeredDatetime	datetime	Date and time when the task was registered.
registeredUserName	string	Name of the user who registered the task.
executionType	enum	Task execution type. (For details about the valid values, see the table ExecutionType in List of enumerators.)
automationDirectorTaskIDs	string[]	Task ID of Ops Center Automator.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	- The format of the request body is invalid. - A query parameter is invalid.
401	Unauthorized	No login 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/objects/IoControlHistory 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:13:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5d3b478672e01d126f372d5f0fcd6b2d6e2227_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : "TaskID",
    "taskName" : "TaskName0010",
    "description" : "TaskDescription",
    "targetMetric" : "IOPS",
    "targetVolumes" : [ "raidLdev#00^00^01", "raidLdev#00^00^02" ],
    "limitationMode" : "ON",
    "limitValue" : 2147483647,
    "status" : "Success",
    "statusLastUpdateDateTime" : "2016-09-05T12:14:00.002+09:00",
    "registeredDatetime" : "2016-09-05T12:13:59.994+09:00",
    "registeredUserName" : "User",
    "executionType" : "AutomationDirector",
    "automationDirectorTaskIDs" : [ "AutoTask1", "AutoTask2" ]
  } ],
  "count" : 1
}