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

GetHostNetworkFacts

GetHostNetworkFacts

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • hostUuidStringRequired

    The host UUID.

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • 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.

  • bondingsListRequired

    See bondings.

    • uuidStringRequired

      The resource UUID.

    • hostUuidStringRequired

      The host UUID.

    • bondingNameStringRequired

      The bond name.

    • modeStringRequired

      The bond mode.

    • xmitHashPolicyStringRequired

      The hash policy.

    • miiStatusStringRequired

      The MII status.

    • macStringRequired

      The MAC address.

    • ipAddressesListRequired

      The IP address.

    • miimonLongRequired

      The MII monitoring interval.

    • allSlavesActiveBooleanRequired

      No description provided.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • slavesListRequired

      See slaves.

      • 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.

  • nicsListRequired

    See nics.

    • 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.

  • errorErrorCodeRequired

    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.

Endpoint

GET/zstack/v1/hosts/network-facts/{hostUuid}

/zstack/v1/hosts/network-facts/{hostUuid}

Operation ID

GetHostNetworkFacts

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/hosts/network-facts/{hostUuid}?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "bondings": [ { "uuid": "c1ff34db684e3b8785572902ef99efea", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "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": "08643629c29d34a0a4a2d858b49a41a4", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "bondingUuid": "c1ff34db684e3b8785572902ef99efea", "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": "14ca7ad13e573cfdb6f929b12b750553", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "bondingUuid": "c1ff34db684e3b8785572902ef99efea", "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" } ] } ], "nics": [ { "uuid": "08643629c29d34a0a4a2d858b49a41a4", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "bondingUuid": "c1ff34db684e3b8785572902ef99efea", "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": "14ca7ad13e573cfdb6f929b12b750553", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "bondingUuid": "c1ff34db684e3b8785572902ef99efea", "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" }, { "uuid": "8d871eb89020363ebc764ed41be4c213", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "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": "d39d0eead2d53e47a8f7b3aca375c1d3", "hostUuid": "e336fa8ef9283fe4a4d746957284379a", "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