List Storage Subsystems of a Storage Site

The List Storage Subsystems of a Storage Site operation lists the storage subsystems associated with the storage site with the given identifier.

HTTP method and URI

GET /api/storage-sites/{storage-site-id}/storage-subsystems

In this request, the URI variable {storage-site-id} is the object-id of the Storage Site object.

Query parameters:

Name Type Rqd/Opt Description
name String Optional Filter pattern (regular expression) to limit returned objects to those that have a matching name property.

Response body contents

On successful completion, the response body is a JSON object with the following fields:

Field name Type Description
storage-subsystems Array of storage-subsystem-info objects Array of storage-subsystem-info objects, described in the next table. The returned array may be empty.

Each nested storage-subsystem-info object contains the following fields:

Field name Type Description
object-uri String/ URI Canonical URI path (object-uri) of the Storage Subsystem object.
name String The name property of the Storage Subsystem object.

Description

This operation lists the storage subsystems that are associated with the identified storage site. The object URI and name are provided for each.

If the object ID {storage-site-id} does not identify a storage site object on the HMC, a 404 (Not Found) status code is returned.

If the name query parameter is specified, the returned list is limited to those storage subsystems that have a name property that matches the specified filter pattern. If the name parameter is omitted, this filtering is not done.

A storage subsystem is included in the list only if the API user has task permission for the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks. If the specified storage site is associated with a storage subsystem but the API user does not have permission to it, that object is simply omitted from the list but no error status code results.

If no storage subsystems are to be included in the results due to filtering or lack of task permission, an empty list is provided and the operation completes successfully.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks.

HTTP status and reason codes

On success, HTTP status code 200 (OK) is returned and the response body is provided as described in Response body contents.

The following HTTP status codes are returned for the indicated errors. The response body is a standard error response body providing the reason code indicated and any associated error message.

Table 1. List Storage Subsystems of a Storage Site: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
14 A query parameter defines an invalid value.
404 (Not Found) 1 The storage site with the object ID {storage-site-id} does not exist on the HMC.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. List Storage Subsystems of a Storage Site: Request
GET /api/storage-sites/13ff101c-941f-11e8-a0c0-fa163e27d492/storage-subsystems 
  HTTP/1.1
x-api-session: 2fdcirhybjv0ogapni5r3z0oo86u7qj87id7rlcons4ce2jfiw
Figure 2. List Storage Subsystems of a Storage Site: Response
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Mon, 30 Jul 2018 21:29:44 GMT
content-type: application/json;charset=UTF-8
content-length: 216
{
   "storage-subsystems":[
      {
         "name":"DS8886 A",
         "object-uri":"/api/storage-subsystems/37af8766-943e-11e8-8ffe-fa163e27d492"
      },
      {
         "name":"DS8870 A",
         "object-uri":"/api/storage-subsystems/76c30590-943e-11e8-9c43-fa163e27d492"
      }
   ]
}