Table 61 Port Property JSON Objects (continued)
DescriptionAPI TypeJSON TypeMember
<Node>:<Slot>:<Port>
format.
(Since WSAPI 1.2)
(Since WSAPI 1.2)portFailoverState EnumnumberfailoverState
For RCIP and iSCSI ports
only; not included in the
JSON object for other ports.
stringstringIPAddr
(Since WSAPI 1.2)
For iSCSI port only; not
included in the JSON object
for other ports.
Name223stringiSCSIName
(Since WSAPI 1.2)
Ethernet node MAC address.MACstringenodeMACAddr
PFC mask.HexstringpfcMask
All-ports Query Errors
The INT_SERV_ERR might be returned upon querying all volumes. For details about this error
code, see Table 5 (page 17). For generic API error codes, see Table 5 (page 17).
Querying A Single Port
To query port information for a single instance, use the HTTP GET method in the URI, with no
message body, where <n:s:p> is the port <node>:<slot>:<port> value:
https://<storage system>:8080/api/v1/ports/<n:s:p>
Single-port Query Success
Upon success, the HTTP code 200 OK is returned.
Unless an internal server error occurs, the response includes a message body as specified in
Table 62 (page 67).
Table 62 Port Collection Message Body for a Single-port Query
DescriptionAPI TypeJSON Type
Storage port properties.Port Property objectobject
(Since WSAPI 1.2)
Single-port Query Errors
Possible errors for a single-port query response are shown in Table 63 (page 67). For generic API
error codes, see Table 5 (page 17).
Table 63 Single-port Query Error Codes
DescriptionHTTP CodeAPI Code
Incorrect port specification.400 Bad RequestINV_INPUT_PORT_SPECIFICATION
(Since WSAPI 1.2)
Port does not exist.404 Not FoundNON_EXISTENT_PORT
(Since WSAPI 1.2)
Querying A Single Port 67