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

CreateBonding

CreateBonding

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • hostUuidsListRequired

      The host UUID list.

    • bondingNameStringRequired

      The bond name.

    • slaveUuidsList

      Optional. The slave interface UUIDs list.

    • slaveNamesList

      Optional. The slave interface name lise.

    • typeStringRequired

      The bond type.

    • modeStringRequired

      The bond mode.

    • xmitHashPolicyString

      Optional. The hash policy.

    • descriptionString

      Optional. The resource description.

    • resourceUuidString

      Optional. The resource UUID.

    • tagUuidsList

      Optional. The tag UUID list.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • inventoryListRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • hostUuidStringRequired

      The host UUID.

    • bondingNameStringRequired

      The bond name.

    • bondingTypeStringRequired

      The bond application type. Options: noBridge and bridgeSlave.

    • speedLongRequired

      The bond speed.

    • modeStringRequired

      The bond mode.

    • xmitHashPolicyStringRequired

      The hash policy.

    • miiStatusStringRequired

      The MII status.

    • macStringRequired

      The MAC address.

    • ipAddressesListRequired

      The IP address.

    • gatewayStringRequired

      The gateway address.

    • callBackIpStringRequired

      The callback IP address.

    • miimonLongRequired

      The MII monitoring interval.

    • typeStringRequired

      The bond type.

    • allSlavesActiveBooleanRequired

      No description provided.

    • descriptionStringRequired

      The resource description.

    • createDateTimestampRequired

      The creation time.

    • lastOpDateTimestampRequired

      The last operation time.

    • slavesListRequired

      See slaves.

      • uuidStringRequired

        The resource UUID.

      • hostUuidStringRequired

        The host UUID.

      • bondingUuidStringRequired

        The bond UUID.

      • interfaceModelStringRequired

        The interface model.

      • vendorIdStringRequired

        The vendor Id.

      • deviceIdStringRequired

        The device Id.

      • subvendorIdStringRequired

        The subset vendor Id.

      • subdeviceIdStringRequired

        The subset device Id.

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

      • gatewayStringRequired

        The gateway address.

      • macStringRequired

        The MAC address.

      • callBackIpStringRequired

        The callback IP address.

      • pciDeviceAddressStringRequired

        The PCI address of the interface.

      • offloadStatusStringRequired

        No description provided.

      • descriptionStringRequired

        The resource description.

      • createDateTimestampRequired

        The creation time.

      • lastOpDateTimestampRequired

        The last operation time.

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

Endpoint

POST/zstack/v1/hosts/bondings

/zstack/v1/hosts/bondings

Operation ID

CreateBonding

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/hosts/bondings' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"hostUuids":["<hostUuids>"],"bondingName":"<bondingName>","slaveUuids":["<slaveUuids>"],"slaveNames":["<slaveNames>"],"type":"<type>","mode":"<mode>","xmitHashPolicy":"<xmitHashPolicy>","description":"<description>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": [ { "hostUuid": "ad58bd08605338648dce127f256f332e", "bondingName": "test", "mode": "802.3ad", "xmitHashPolicy": "layer2+3", "ipAddresses": [ "192.168.1.1" ], "type": "LinuxBonding", "slaves": [ { "uuid": "97e1e9fb0cd73af8bd3e84376e59fa26", "hostUuid": "ad58bd08605338648dce127f256f332e", "interfaceName": "eno1", "interfaceType": "bondingSlave", "speed": 1000, "slaveActive": true, "carrierActive": true, "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