2.23.1 Obtaining Volume List
The API acquires a list of volumes.
Execution permission
Admin, Modify
API version
v1
Request format
GET http[s]://host:port/Analytics/version/objects/Volumes
Request body
Not applicable.
Response body
The structure of the response body and the object attributes are as follows:{ "data":[{ "instanceID":"...", "status":"...", "ldev":"...", "storageSubsystemID":"...", "storageSubsystem":"...", "storageSubsystemMonitorStatus":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "groupIDs":["...", ...], "groupNames":["...", ...], "gradeNames":["...", ...], "gradeOrders":["...", ...], "pluginId":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
---|---|---|
data |
Volume[] |
A list of Volume objects. For details about Volume, 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. |
data (Type: Volume)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID of the volume |
status |
enum |
Status of the volume (For details about the specifiable values, see the table NodeStatusType in List of enumerators.) The specifiable values are as follows:
|
ldev |
string |
Name of the LDEV |
storageSubsystemID |
long |
ID of the storage system that the volume belongs to |
storageSubsystem |
string |
Name of the storage system that the volume belongs to |
storageSubsystemMonitorStatus |
enum |
Monitoring status of the storage system that the volume belongs to (For details about the specifiable values, see the table ManagementLevelType in List of enumerators.) The specifiable values are as follows:
|
thresholdProfileID |
long |
ID of the threshold profile assigned to the volume |
thresholdProfileName |
string |
Name of the threshold profile assigned to the volume |
originalThresholdProfileID |
string |
Original threshold profile ID of the threshold profile assigned to the volume |
groupIDs |
long[] |
ID of the consumer assigned to the volume |
groupNames |
string[] |
Name of the consumer assigned to the volume |
gradeNames |
string[] |
Name of the grade of the consumer assigned to the volume |
gradeOrders |
integer[] |
Priority of the grade of the consumer assigned to the volume |
pluginId |
string |
ID of the plug-in applied to the volume. |
pagination (Type: Pagination)
Attribute |
Type |
Description |
---|---|---|
page |
integer |
page |
pageSize |
integer |
Size of the pages |
numPages |
integer |
Number of the pages |
totalCount |
integer |
Number of the objects |
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 /Analytics/v1/objects/Volumes HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Accept-Language: ja [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 07:11:36 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO df3a7ac35f3b99a9b2afafd22d433167067da9_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 540, "status" : "Unknown", "ldev" : "vol0 (LU NUM=699d3b60-18f9-11de-a169-00a09810f3f4)", "storageSubsystemID" : 6, "storageSubsystem" : "FAS2050A-2", "storageSubsystemMonitorStatus" : "Manage", "thresholdProfileID" : 21, "thresholdProfileName" : "Default Profile for Volume", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ] }, { "instanceID" : 534, "status" : "Unknown", "ldev" : "vol1 (LU NUM=7cb5b900-1c0e-11de-9f89-00a09810f3f4)", "storageSubsystemID" : 6, "storageSubsystem" : "FAS2050A-2", "storageSubsystemMonitorStatus" : "Manage", "thresholdProfileID" : 21, "thresholdProfileName" : "Default Profile for Volume", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ] } ], "count" : 2 }