跳转到主要内容
API Explorer|API Explorer
资源中心/裸金属管理(Plus)/裸金属管理相关接口
POSTBare Metal Management Operations起始版本 2.6.0同步需要认证

创建裸机实例

创建裸机实例

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • chassisUuidString必填

      裸机设备UUID

    • imageUuidString必填

      镜像UUID

    • templateUuidString

      预配置模板UUID

    • usernameString

      系统用户

    • passwordString

      系统密码

    • nicCfgsMap

      裸机网络配置

    • bondingCfgsMap

      网卡绑定配置

    • customConfigurationsMap

      自定义变量

    • strategyString

      裸机实例创建策略

    • resourceUuidString

      资源UUID。若指定，则裸机实例会以该字段值作为UUID。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryBaremetalInstanceInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • pxeServerUuidString必填

      暂无描述。

    • chassisUuidString必填

      裸机设备UUID

    • imageUuidString必填

      镜像UUID

    • platformString必填

      系统平台

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • bmNicsList必填

      详情参考bmNics

      • uuidString必填

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

      • baremetalInstanceUuidString必填

        裸机实例UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • macString必填

        MAC地址

      • ipString必填

        IP地址

      • netmaskString必填

        子网掩码

      • gatewayString必填

        网关

      • metadataString必填

        附加元数据。

      • pxeBoolean必填

        是否PXE启动网卡

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/baremetal/instances

/zstack/v1/baremetal/instances

操作 ID

CreateBaremetalInstance

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/baremetal/instances' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","chassisUuid":"<chassisUuid>","imageUuid":"<imageUuid>","templateUuid":"<templateUuid>","username":"<username>","password":"<password>","nicCfgs":{},"bondingCfgs":{},"customConfigurations":{},"strategy":"<strategy>","resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "1dc13c821a713f7fbfa7dd754f100a73", "name": "BM-1", "description": "This is a baremetal instance.", "zoneUuid": "0f67724b4dc5397ea39751fda57c4ce6", "clusterUuid": "7921d51dba31317e8c09d50e44abd010", "chassisUuid": "5183b18300e43aa784a643b86a9772b7", "imageUuid": "a39b3870f3ae393cadcc3b4cfb454653", "platform": "Linux", "state": "Created", "status": "Unprovisioned", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "bmNics": [ { "uuid": "006915f4766c32ee8b09bf951dd43264", "baremetalInstanceUuid": "1dc13c821a713f7fbfa7dd754f100a73", "l3NetworkUuid": "1fa935a68b4e312aa482df27b3b759a5", "mac": "6c:b3:11:1b:0b:1e", "ip": "192.168.0.10", "netmask": "255.255.255.0", "gateway": "192.168.0.1", "pxe": false } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史