You can obtain information about a specific Storage I/O control configuration task, such as name, description, and status.
Execution permission
Admin, StorageOps, Modify
Request line
GET baseURL/v1/objects/IoControlHistory/{id}
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows: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. |
|
401 |
Unauthorized |
No login privilege. |
|
404 |
Not Found |
The resource was not found. |
|
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/dummyTaskId 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:15:13 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 7891f7d443804d8e3f5ac1159687edd1d4fbbbec_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
[Response Body]
{
"instanceID" : "dummyTaskId",
"taskName" : "dummyTask",
"description" : "dummyDescription",
"targetMetric" : "IOPS",
"targetVolumes" : [ "raidLdev#dummy1", "raidLdev#dummy2" ],
"limitationMode" : "ON",
"limitValue" : 2147483647,
"status" : "Success",
"statusLastUpdateDateTime" : "2016-09-05T12:15:13.862+09:00",
"registeredDatetime" : "2016-09-05T12:15:13.862+09:00",
"registeredUserName" : "dummyUser",
"executionType" : "AutomationDirector",
"automationDirectorTaskIDs" : [ "hadtask1", "hadtask2" ]
}