GetHostMultipathTopology

API Request

URLs

GET zstack/v1/storage-devices/multipath/topology

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/multipath/topology?hostUuid=da8052bf25c43b73ad0c9a7546d166ae&diskUuids=360014058e50754920324473a4c85c767&diskUuids=36001405a5d87d462c2c47acb683c4c37

Request Parameters

Name	Type	Location	Description	Starting Version
hostUuid	String	query	The host UUIDs.	5.3.0
diskUuids	List	query	The disk UUIDs.	5.3.0
systemTags	List	query	Optional. The system tags.	5.3.0
userTags	List	query	Optional. The user tags.	5.3.0

API Response

Sample Response

{
  "results": [
    {
      "diskUuid": "360014058e50754920324473a4c85c767",
      "devices": [
        {
          "disk": "sda",
          "status": "active",
          "state": "running",
          "target": "iqn.2003-01.org.linux-iscsi.172-20-14-68.x8664:sn.23019b11e653",
          "targetType": "iSCSI"
        },
        {
          "disk": "sdb",
          "status": "enabled",
          "state": "running",
          "target": "iqn.2003-01.org.linux-iscsi.172-20-14-68.x8664:sn.23019b11e653",
          "targetType": "iSCSI"
        }
      ]
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		5.3.0
results	List	For more information, see results	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

#results

Name	Type	Description	Starting Version
diskUuid	String	The disk UUIDs.	5.3.0
devices	List	For more information, see devices	5.3.0

#devices

Name	Type	Description	Starting Version
disk	String	The disk name.	5.3.0
state	String	The disk health status.	5.3.0
status	String	The disk enabled status.	5.3.0
target	String	The disk location.	5.3.0
targetType	String	The disk target type.	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

GetHostMultipathTopologyAction action = new GetHostMultipathTopologyAction();
action.hostUuid = "da8052bf25c43b73ad0c9a7546d166ae";
action.diskUuids = asList("360014058e50754920324473a4c85c767","36001405a5d87d462c2c47acb683c4c37");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetHostMultipathTopologyAction.Result res = action.call();

Python SDK

GetHostMultipathTopologyAction action = GetHostMultipathTopologyAction()
action.hostUuid = "da8052bf25c43b73ad0c9a7546d166ae"
action.diskUuids = [360014058e50754920324473a4c85c767, 36001405a5d87d462c2c47acb683c4c37]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetHostMultipathTopologyAction.Result res = action.call()

PreviousGetCandidateNetworkInterfaces NextGetCandidateInterfaceVlanIds