跳转到主要内容
ZStack
资源中心/裸金属管理(Plus)/安装服务相关接口

创建部署服务器

创建部署服务器

POST/zstack/v1/baremetal/pxeservers

操作 ID

CreateBaremetalPxeServer

起始版本

3.1.1

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • name
      String必填

      资源名称

    • description
      String

      资源的详细描述

    • dhcpInterface
      String必填

      DHCP请求监听网卡

    • dhcpRangeBegin
      String

      DHCP地址范围起始

    • dhcpRangeEnd
      String

      DHCP地址范围终止

    • dhcpRangeNetmask
      String

      DHCP地址范围掩码

    • zoneUuid
      String必填

      区域UUID

    • hostname
      String必填

      暂无描述。

    • sshUsername
      String必填

      SSH用户名。

    • sshPassword
      String必填

      SSH密码。

    • sshPort
      Integer

      可选。

    • storagePath
      String必填

      存储路径。

    • resourceUuid
      String

      可选。

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventory
    BaremetalPxeServerInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • zoneUuid
      String必填

      区域UUID

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • hostname
      String必填

      部署服务器地址

    • sshUsername
      String必填

      部署服务器SSH账户

    • sshPassword
      String必填

      部署服务器SSH密码

    • sshPort
      Integer必填

      部署服务器SSH端口

    • storagePath
      String必填

      部署服务器存储路径

    • dhcpInterface
      String必填

      DHCP请求监听网卡

    • dhcpInterfaceAddress
      String必填

      DHCP请求监听网卡IP

    • dhcpRangeBegin
      String必填

      DHCP地址范围起始

    • dhcpRangeEnd
      String必填

      DHCP地址范围终止

    • dhcpRangeNetmask
      String必填

      DHCP子网掩码

    • state
      String必填

      部署服务器运行状态

    • status
      String必填

      部署服务器连接状态

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • totalCapacity
      Long必填

      存储路径总容量

    • availableCapacity
      Long必填

      存储路径可用容量

    • attachedClusterUuids
      List必填

      部署服务器挂载集群UUID列表