Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/Host Operations
GETHost OperationsSince 3.9.0SynchronousAuth Required

QueryHostNetworkInterface

QueryHostNetworkInterface

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The resource UUID.

    • hostUuidStringRequired

      The host UUID.

    • bondingUuidStringRequired

      The bond UUID.

    • interfaceNameStringRequired

      The interface name.

    • interfaceTypeStringRequired

      The interface type. Options: nomaster, bridgeSlave, and bondSlave.

    • speedLongRequired

      The interface speed.

    • slaveActiveBooleanRequired

      The bond link status.

    • carrierActiveBooleanRequired

      The physical link status.

    • ipAddressesListRequired

      The IP address.

    • macStringRequired

      The MAC address.

    • pciDeviceAddressStringRequired

      The PCI address of the interface.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

Endpoint

GET/zstack/v1/hosts/nics

/zstack/v1/hosts/nics

Operation ID

QueryHostNetworkInterface

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/hosts/nics' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "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" } ] }

Change History

This API has no change history records yet.

View all change history