API Reference | 5.5.30 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/storage-devices/hba

GET zstack/v1/storage-devices/hba/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/storage-devices/hba?q=uuid=db041d8a238732be82740eaf5a43d252

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/storage-devices/hba/1698716626f33b6fb1637a76590e1fe6

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryFcHbaDevice, and pressing the Tab key.

API Response

Sample Response

{
  "inventories": [
    {
      "portName": "10000090fab38778",
      "portState": "Online",
      "speed": "8 Gbit",
      "supportedSpeeds": "16 Gbit",
      "symbolicName": "QLE2692 FW:v9.07.00 DVR:v10.02.00.106-k",
      "supportedClasses": "Class 3",
      "uuid": "511a5ac34b423ac99a33d5c863531d2e",
      "name": "host",
      "hostUuid": "38e3ebc0b54e3cf8a99db5f7c80ee59e",
      "hbaType": "FC"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		5.3.0
inventories	List	See inventories	5.3.0
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error	5.3.0

#inventories

Name	Type	Description	Starting version
uuid	String	The resource UUID.	5.3.0
name	String	The resource name.	5.3.0
hostUuid	String	The host UUID.	5.3.0
portName	String	The port name.	5.3.0
portState	String	The port status.	5.3.0
hbaType	String	The HBA type.	5.3.0
speed	String	The device speed.	5.3.0
supportedSpeeds	String	The supported speed.	5.3.0
symbolicName	String	The symbolic name.	5.3.0
supportedClasses	String	The supported class.	5.3.0
createDate	String	The creation date.	5.3.0
lastOpDate	String	The last operation date.	5.3.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	5.3.0
description	String	The brief description of the error.	5.3.0
details	String	The details about the error.	5.3.0
elaboration	String	The reserved field. Default value: null.	5.3.0
opaque	LinkedHashMap	The reserved field. Default value: null.	5.3.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	5.3.0

SDK Sample

Java SDK

QueryFcHbaDeviceAction action = new QueryFcHbaDeviceAction();
action.conditions = asList("uuid=744cbe74c6f8365dafdbcf9568cfafa0");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryFcHbaDeviceAction.Result res = action.call();

Python SDK

QueryFcHbaDeviceAction action = QueryFcHbaDeviceAction()
action.conditions = ["uuid=e8b3f35dce0c38da8cec8a56347899e9"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryFcHbaDeviceAction.Result res = action.call()

QueryHBADevice

API Request

API Response

SDK Sample