API Reference | 4.8.38 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/hosts/nics

GET zstack/v1/hosts/nics/{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/hosts/nics

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hosts/nics/df5b59fdb3c9388297fd89c5fa6dea65

Queryable Fields

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

API Response

Sample Response

{
  "inventories": [
    {
      "uuid": "310ca8ce7010363ca7ac83d37373238f",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "bondingUuid": "6fbe88605eed35ba95399687585be3d1",
      "interfaceName": "eno1",
      "interfaceType": "bondingSlave",
      "speed": 1000.0,
      "slaveActive": true,
      "carrierActive": true,
      "mac": "98:03:9b:00:ea:f1",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    },
    {
      "uuid": "3213802883d13c72b54c084233c4de2a",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "bondingUuid": "6fbe88605eed35ba95399687585be3d1",
      "interfaceName": "eno2",
      "interfaceType": "bondingSlave",
      "speed": 1000.0,
      "slaveActive": false,
      "carrierActive": false,
      "mac": "98:03:9b:00:ea:f1",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    },
    {
      "uuid": "3015b6b0c74d316699ebe09dc60e1001",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "interfaceName": "ens2f0",
      "interfaceType": "noMaster",
      "speed": 1000.0,
      "slaveActive": true,
      "carrierActive": true,
      "ipAddresses": [
        "169.254.0.115/24"
      ],
      "mac": "98:03:9b:00:ea:f2",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    },
    {
      "uuid": "e3b513e177a1313a93b32b290643f849",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "interfaceName": "ens2f1",
      "interfaceType": "bridgeSlave",
      "speed": 1000.0,
      "slaveActive": false,
      "carrierActive": false,
      "mac": "98:03:9b:00:ea:f3",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	3.9.0
inventories	List	See inventories.	3.9.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.	3.9.0
description	String	The brief description of the error.	3.9.0
details	String	The details about the error.	3.9.0
elaboration	String	The reserved field. Default value: null.	3.9.0
opaque	LinkedHashMap	The reserved field. Default value: null.	3.9.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.	3.9.0

#inventories

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	3.9.0
hostUuid	String	The host UUID.	3.9.0
bondingUuid	String	The bond UUID.	3.9.0
interfaceName	String	The interface name.	3.9.0
interfaceType	String	The interface type. Options: nomaster, bridgeSlave, and bondSlave.	3.9.0
speed	Long	The interface speed.	3.9.0
slaveActive	Boolean	The bond link status.	3.9.0
carrierActive	Boolean	The physical link status.	3.9.0
ipAddresses	List	The IP address.	3.9.0
mac	String	The MAC address.	3.9.0
pciDeviceAddress	String	The PCI address of the interface.	3.9.0
createDate	Timestamp	The creation date.	3.9.0
lastOpDate	Timestamp	The last operation date.	3.9.0

SDK Sample

Java SDK

QueryHostNetworkInterfaceAction action = new QueryHostNetworkInterfaceAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHostNetworkInterfaceAction.Result res = action.call();

Python SDK

QueryHostNetworkInterfaceAction action = QueryHostNetworkInterfaceAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHostNetworkInterfaceAction.Result res = action.call()