Get Storage Path Properties

The Get Storage Path Properties operation retrieves the properties of a single Storage Path element object.

HTTP method and URI

GET /api/storage-control-units/{storage-control-unit-id}/storage-paths/{storage-path-id}

In this request, the URI variable {storage-control-unit-id} is the object ID of the Storage Control Unit object and the URI variable {storage-path-id} is the element ID of the Storage Path element object.

Response body contents

On successful completion, the response body is a JSON object that provides the current values of the properties for the Storage Path object as defined in the Data model. Field names and data types in the JSON object are the same as the property names and data types defined in the data model.

Description

Returns the current values of the properties for the Storage Path element object as defined in the Table 1.

If the API user does not have action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks, a 403 (Forbidden) status code is returned. If the object ID {storage-control-unit-id} does not identify a Storage Control Unit object on the HMC, or if the element ID {storage-path-id} does not identify a storage path in the storage control unit, a 404 (Not Found) status code is returned.

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, the HTTP status code 200 (OK) is returned and the response body is provided as described in the Response body contents.

Otherwise, 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 associated error message.

Table 1. Get Storage Path Properties: 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.
403 (Forbidden) 1 The API user does not have action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks.
404 (Not Found) 1 A storage control unit with object-id {storage-control-unit-id} does not exist on the HMC.
5 A storage path with element-id {storage-path-id} does not exist for the storage control unit.

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

Example HTTP interaction

Figure 1. Get Storage Path Properties: Request
GET /api/storage-control-units/69bf384a-94d5-11e8-8ffe-fa163e27d492/storage-paths/
  8746e9c8-94d8-11e8-a5c5-fa163e3fe47d HTTP/1.1
x-api-session: 2bgudgv3iuzlc6ny30fs9v3pb0w43snsewp9dtt5h0qls29dpt
Figure 2. Get Storage Path Properties: Response
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Tue, 31 Jul 2018 15:44:39 GMT
content-type: application/json;charset=UTF-8
content-length: 466
{
   "adapter-port-uri":"/api/adapters/20633658-941f-11e8-8625-fa163e27d492/storage-ports/
     0",
   "class":"storage-path",
   "element-id":"8746e9c8-94d8-11e8-a5c5-fa163e3fe47d",
   "element-uri":"/api/storage-control-units/69bf384a-94d5-11e8-8ffe-fa163e27d492/
     storage-paths/8746e9c8-94d8-11e8-a5c5-fa163e3fe47d",
   "exit-port":"00",
   "exit-switch-uri":"/api/storage-switches/b65d1aee-9437-11e8-9c43-fa163e27d492",
   "parent":"/api/storage-control-units/69bf384a-94d5-11e8-8ffe-fa163e27d492"
}