Skip to main content
ZStack
Resource Center/Elastic Bare Metal Management(Plus)

CreateBareMetal2ProvisionNetwork

CreateBareMetal2ProvisionNetwork

POST/zstack/v1/baremetal2/provision-networks

Operation ID

CreateBareMetal2ProvisionNetwork

Since

4.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • name
      StringRequired

      The name of the deployment network.

    • description
      String

      Optional. The detailed description of the deployment network.

    • zoneUuid
      StringRequired

      The zone UUID.

    • dhcpInterface
      StringRequired

      The name of the DHCP NIC.

    • dhcpRangeStartIp
      StringRequired

      The starting IP address that DHCP assigns to a bare metal instance.

    • dhcpRangeEndIp
      StringRequired

      The ending IP address that DHCP assigns to a bare metal instance.

    • dhcpRangeNetmask
      StringRequired

      The netmask of the IP range from which the DHCP server assigns an IP address to a bare metal instance.

    • dhcpRangeGateway
      String

      Optional. The gateway IP address.

    • resourceUuid
      String

      Optional. The deployment network UUID.

    • tagUuids
      List

      Optional. The tag UUIDs.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • inventory
    BareMetal2ProvisionNetworkInventoryRequired

    See inventory

    • uuid
      StringRequired

      The deployment network UUID.

    • zoneUuid
      StringRequired

      The zone UUID.

    • name
      StringRequired

      The name of the deployment network.

    • description
      StringRequired

      The detailed description of the deployment network.

    • dhcpInterface
      StringRequired

      The name of the DHCP NIC.

    • dhcpRangeStartIp
      StringRequired

      The starting IP address that DHCP assigns to a bare metal instance.

    • dhcpRangeEndIp
      StringRequired

      The ending IP address that DHCP assigns to a bare metal instance.

    • dhcpRangeNetmask
      StringRequired

      The netmask of the IP range from which the DHCP server assigns an IP address to a bare metal instance.

    • dhcpRangeGateway
      StringRequired

      The gateway IP address.

    • dhcpRangeNetworkCidr
      StringRequired

      The CIDR block.

    • state
      StringRequired

      The state of the deployment network.

    • createDate
      TimestampRequired

      The time when the deployment network was created.

    • lastOpDate
      TimestampRequired

      The time when the deployment network was last modified.

    • attachedClusterUuids
      ListRequired

      The attached cluster UUIDs.