Skip to main content
API Explorer|API Explorer
Compute Management/Host Related Interfaces
GETHost Related InterfacesSince 3.9.0SynchronousAuth Required

Query Host NIC Information

Query Host NIC Information

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

    Error code. If not null, the operation failed. If null, the operation succeeded. See details error

    • codeStringRequired

      Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, default is null

    • opaqueLinkedHashMapRequired

      Reserved field, default is null

    • causeErrorCodeRequired

      Root cause, the error that caused the current error. If there is no original error, this field is null

  • inventoriesListRequired

    See details inventories

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • hostUuidStringRequired

      Host UUID

    • bondingUuidStringRequired

      Bond UUID

    • interfaceNameStringRequired

      NIC name

    • interfaceTypeStringRequired

      NIC usage state, can be nomaster, bridgeSlave, bondSlave

    • speedLongRequired

      NIC speed

    • slaveActiveBooleanRequired

      Bond link status

    • carrierActiveBooleanRequired

      Physical link status

    • ipAddressesListRequired

      IP addresses

    • macStringRequired

      MAC address

    • pciDeviceAddressStringRequired

      NIC PCI address

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

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