Document navigation

QueryHostNetworkBonding

API Request

URLs
GET zstack/v1/hosts/bondings
GET zstack/v1/hosts/bondings/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hosts/bondings
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hosts/bondings/4557b1f12ef7393c926b8b7223ddebac

Queryable Fields

Run the CLI command tool, enter QueryHostNetworkBonding and press Tab to view all queryable fields and resources that support cross-table queries.

API Response

Response Example
{
  "inventories": [
    {
      "uuid": "2e2226e18e853f20a5791684a1b644c8",
      "hostUuid": "903696c585a639bb8049713b98d93437",
      "bondingName": "bond0",
      "mode": "active-backup 1",
      "xmitHashPolicy": "layer2 0",
      "miiStatus": "up",
      "mac": "ac:1f:6b:93:6c:8c",
      "ipAddresses": [
        "172.20.0.116/16"
      ],
      "miimon": 100.0,
      "allSlavesActive": true,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "slaves": [
        {
          "uuid": "17a40aa475cf322494ea82e09066892e",
          "hostUuid": "903696c585a639bb8049713b98d93437",
          "bondingUuid": "2e2226e18e853f20a5791684a1b644c8",
          "interfaceName": "eno1",
          "interfaceType": "bondingSlave",
          "speed": 1000.0,
          "slaveActive": true,
          "carrierActive": true,
          "mac": "ac:1f:6b:93:6c:8c",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        },
        {
          "uuid": "c3716c87b9173cbb8315e7d7f3645bc4",
          "hostUuid": "903696c585a639bb8049713b98d93437",
          "bondingUuid": "2e2226e18e853f20a5791684a1b644c8",
          "interfaceName": "eno2",
          "interfaceType": "bondingSlave",
          "speed": 1000.0,
          "slaveActive": false,
          "carrierActive": false,
          "mac": "ac:1f:6b:93:6c:8c",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ]
    }
  ]
}
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 3.9.0
inventories List See details inventories 3.9.0
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 3.9.0
description String Brief description of the error 3.9.0
details String Detailed error information 3.9.0
elaboration String Reserved field, default is null 3.9.0
opaque LinkedHashMap Reserved field, default is null 3.9.0
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 3.9.0
#inventories
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.9.0
hostUuid String Host UUID 3.9.0
bondingName String Bond name 3.9.0
mode String Bond mode 3.9.0
xmitHashPolicy String Hash policy 3.9.0
miiStatus String MII status 3.9.0
mac String MAC address 3.9.0
ipAddresses List IP addresses 3.9.0
miimon Long MII monitor interval 3.9.0
allSlavesActive Boolean The all slaves active. 3.9.0
createDate Timestamp Creation time 3.9.0
lastOpDate Timestamp Last modification time 3.9.0
slaves List See details slaves 3.9.0
#slaves
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.9.0
hostUuid String Host UUID 3.9.0
bondingUuid String Bond UUID 3.9.0
interfaceName String NIC name 3.9.0
interfaceType String NIC usage state, can be nomaster, bridgeSlave, bondSlave 3.9.0
speed Long NIC speed 3.9.0
slaveActive Boolean Bond link status 3.9.0
carrierActive Boolean Physical link status 3.9.0
ipAddresses List IP addresses 3.9.0
mac String MAC address 3.9.0
pciDeviceAddress String NIC PCI address 3.9.0
createDate Timestamp Creation time 3.9.0
lastOpDate Timestamp Last modification time 3.9.0

SDK Examples

Java SDK
QueryHostNetworkBondingAction action = new QueryHostNetworkBondingAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHostNetworkBondingAction.Result res = action.call();
Python SDK
QueryHostNetworkBondingAction action = QueryHostNetworkBondingAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHostNetworkBondingAction.Result res = action.call()
API Reference | ZStack ZSphere · ZVF | ZStack Resource Center