Skip to main content
API Explorer|API Explorer
Resource Center/Elastic Bare Metal Management(Plus)
POSTElastic Bare Metal Management(Plus)Since 5.5.6SynchronousAuth Required

CreateBareMetal2InstanceFromVmBackup

CreateBareMetal2InstanceFromVmBackup

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • groupUuidStringRequired

    The backup data group UUID.

Body Fields

  • nameStringRequired

    The resource name.

  • descriptionString

    Optional. The detailed description of the resource.

  • zoneUuidString

    Optional. The zone UUID.

  • clusterUuidString

    Optional. The cluster UUID.

  • gatewayUuidString

    Optional. The bare metal gateway node UUID.

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.

  • inventoryBareMetal2InstanceInventoryRequired

    See inventory.

    • chassisUuidStringRequired

      The bare metal node UUID.

    • lastChassisUuidStringRequired

      The last bare metal node UUID.

    • gatewayUuidStringRequired

      The bare metal gateway node UUID.

    • lastGatewayUuidStringRequired

      The last bare metal gateway node UUID.

    • chassisOfferingUuidStringRequired

      The chassis offering UUID.

    • gatewayAllocatorStrategyStringRequired

      The bare metal gateway node allocation strategy.

    • statusStringRequired

      The connection status.

    • provisionTypeStringRequired

      No description provided.

    • agentVersionStringRequired

      代理版本。

    • isLatestAgentbooleanRequired

      是否最新代理。

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • zoneUuidStringRequired

      The zone UUID.

    • clusterUuidStringRequired

      The cluster UUID.

    • imageUuidStringRequired

      The image UUID.

    • hostUuidStringRequired

      The host UUID.

    • lastHostUuidStringRequired

      最近一次主机UUID。

    • instanceOfferingUuidStringRequired

      The instance offering UUID.

    • rootVolumeUuidStringRequired

      The root volume UUID.

    • platformStringRequired

      The platform type.

    • architectureStringRequired

      No description provided.

    • defaultL3NetworkUuidStringRequired

      The default L3 network UUID.

    • typeStringRequired

      The type.

    • hypervisorTypeStringRequired

      The hypervisor type.

    • memorySizeLongRequired

      The memory size.

    • cpuNumIntegerRequired

      The CPU number.

    • cpuSpeedLongRequired

      The CPU speed.

    • allocatorStrategyStringRequired

      No description provided.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • stateStringRequired

      The state.

    • guestOsTypeStringRequired

      No description provided.

    • provisionNicsBareMetal2InstanceProvisionNicInventoryRequired

      See provisionNics.

      • uuidStringRequired

        The resource UUID.

      • networkUuidStringRequired

        The bare metal provisioning network UUID.

      • macStringRequired

        The MAC address.

      • ipStringRequired

        The IP address.

      • netmaskStringRequired

        The netmask.

      • gatewayStringRequired

        The gateway.

      • metadataStringRequired

        附加元数据。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • vmNicsListRequired

      See vmNics.

      • uuidStringRequired

        The resource UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ipStringRequired

        来源IP地址。

      • macStringRequired

        No description provided.

      • hypervisorTypeStringRequired

        No description provided.

      • netmaskStringRequired

        No description provided.

      • gatewayStringRequired

        No description provided.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        IP版本。

      • driverTypeStringRequired

        No description provided.

      • internalNameStringRequired

        内部名称。

      • deviceIdIntegerRequired

        设备ID。

      • typeStringRequired

        类型。

      • stateStringRequired

        The NIC state.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • usedIpsListRequired

        See usedIps.

        • uuidStringRequired

          The resource UUID.

        • ipRangeUuidStringRequired

          The IP range UUID.

        • l3NetworkUuidStringRequired

          The L3 network UUID.

        • ipVersionIntegerRequired

          IP版本。

        • ipStringRequired

          来源IP地址。

        • netmaskStringRequired

          No description provided.

        • gatewayStringRequired

          No description provided.

        • usedForStringRequired

          The allocation reason.

        • ipInLonglongRequired

          No description provided.

        • ipInBinarybyte[]Required

          No description provided.

        • vmNicUuidStringRequired

          The VM instance NIC UUID.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

    • allVolumesListRequired

      See allVolumes.

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The detailed description of the resource.

      • primaryStorageUuidStringRequired

        The primary storage UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • diskOfferingUuidStringRequired

        The disk offering UUID.

      • rootImageUuidStringRequired

        根镜像UUID。

      • installPathStringRequired

        安装路径。

      • typeStringRequired

        类型。

      • formatStringRequired

        数据格式或导出格式。

      • sizeLongRequired

        返回记录数。

      • actualSizeLongRequired

        实际大小。

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        当前状态。

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • isShareableBooleanRequired

        是否可分享。

      • volumeQosStringRequired

        No description provided.

      • lastDetachDateTimestampRequired

        最近一次detach时间。

      • lastVmInstanceUuidStringRequired

        最近一次云主机实例UUID。

    • vmCdRomsListRequired

      See vmCdRoms.

      • uuidStringRequired

        The resource UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • deviceIdIntegerRequired

        设备ID。

      • isoUuidStringRequired

        No description provided.

      • isoInstallPathStringRequired

        iso安装路径。

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The detailed description of the resource.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

POST/zstack/v1/baremetal2-instance/from/vm-backup/{groupUuid}

/zstack/v1/baremetal2-instance/from/vm-backup/{groupUuid}

Operation ID

CreateBareMetal2InstanceFromVmBackup

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/baremetal2-instance/from/vm-backup/{groupUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"name":"<name>","description":"<description>","zoneUuid":"<zoneUuid>","clusterUuid":"<clusterUuid>","gatewayUuid":"<gatewayUuid>","chassisUuid":"<chassisUuid>","chassisOfferingUuid":"<chassisOfferingUuid>","chassisDiskUuid":"<chassisDiskUuid>","primaryStorageUuidForRootVolume":"<primaryStorageUuidForRootVolume>","primaryStorageUuidForDataVolume":"<primaryStorageUuidForDataVolume>","dataDiskOfferingUuids":["<dataDiskOfferingUuids>"],"rootVolumeSystemTags":["<rootVolumeSystemTags>"],"dataVolumeSystemTags":["<dataVolumeSystemTags>"],"gatewayAllocatorStrategy":"<gatewayAllocatorStrategy>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "chassisUuid": "81554a6ff599416b9e52ced2af50f6e9", "lastChassisUuid": "59fd7178455f479da6bc83de953898ea", "gatewayUuid": "8fbe18d4be76461383b540611df22b7e", "lastGatewayUuid": "d492e5b96f5a4fa88cb0ac304902f5c2", "chassisOfferingUuid": "6ef976116b4346de88d4e70f2ff8498c", "status": "Connected", "provisionType": "Remote", "agentVersion": "2.0.0", "isLatestAgent": true, "uuid": "3261d308bf1b4295a8bbdc1c52b08e33", "name": "BM-1", "description": "This is a BareMetal2 Instance.", "zoneUuid": "d5849358f65c40518904cdbaba78b821", "clusterUuid": "ce69c134f6344119af9faeaf6f0a735a", "imageUuid": "9da74193c8b5413d890955fcaef694cf", "rootVolumeUuid": "3a29abbc54c040f597469300200aaa7b", "platform": "Linux", "type": "baremetal2", "memorySize": 8589934592, "cpuNum": 8, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Running" } }

Change History

This API has no change history records yet.

View all change history