2.22.1 Obtaining Storage System List
The API acquires a list of storage systems.
Execution permission
Admin, Modify
API version
v1
Request format
GET http[s]://host:port/Analytics/version/objects/StorageSystems
Request body
Not applicable.
Response body
The structure of the response body and the object attributes are as follows:{ "data":[{ "instanceID":"...", "name":"...", "ipAddress":"...", "status":"...", "monitorStatus":"...", "description":"...", "usedCredentialID":"...", "usedCredentials":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "accessPointType":"...", "accessPointSnmpVersion":"...", "accessPointIpAddress":"...", "accessPointUser":"...", "pluginId":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
---|---|---|
data |
StorageSystem[] |
A list of StorageSystem objects. For details about StorageSystem, 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: StorageSystem)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID of the storage system |
name |
string |
Name of the storage system |
ipAddress |
string |
IP address of the storage system |
status |
enum |
Status of the storage system (For details about the specifiable values, see the table NodeStatusType in List of enumerators.) The specifiable values are as follows:
|
monitorStatus |
enum |
Monitoring status of the storage system. (For details about the specifiable values, see the table ManagementLevelType in List of enumerators.) The specifiable values are as follows:
|
description |
string |
Detailed information about the storage system |
usedCredentialID |
long |
Name of authentication information used for detection |
usedCredentials |
string |
ID for authentication information used for detection |
thresholdProfileID |
long |
ID of the threshold profile assigned to the storage system |
thresholdProfileName |
string |
Name of the threshold profile assigned to the storage system |
originalThresholdProfileID |
string |
Original threshold profile ID of the threshold profile assigned to the storage system |
accessPointType |
enum |
Type of authentication information used for detection. (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows:
|
accessPointSnmpVersion |
enum |
SNMP version of credential (For details about the specifiable values, see the table SnmpVersion in List of enumerators.) The specifiable values are as follows:
|
accessPointIpAddress |
string |
IP address used for connections to monitoring targets |
accessPointUser |
string |
User ID used for connections to monitoring targets |
pluginId |
string |
ID for the plug-in applied to the storage system. |
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/StorageSystems 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 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 6, "name" : "storage", "ipAddress" : "10.197.87.17, 192.168.20.54", "status" : "Unknown", "monitorStatus" : "Manage", "description" : "Storage Systems", "usedCredentialID" : 10, "usedCredentials" : "172.17.3.107", "thresholdProfileID" : 14, "thresholdProfileName" : "Default Profile for Storage (SMI-S WBEM)", "accessPointType" : "WBEM", "accessPointIpAddress" : "172.17.3.107", "accessPointUser" : "Administrator" } ], "count" : 1 }