Skip to main content
API Explorer|API Explorer
Compute Management/VM Related Interfaces
PUTVM Related InterfacesSince 0.6SynchronousAuth Required

Set Virtual Machine Boot Order

Set Virtual Machine Boot Order

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    Virtual Machine UUID

Body Fields

  • setvmbootorderObjectRequired

    setvmbootorder request body object.

    • bootOrderList

      Boot device. CdRom: CD-ROM, HardDisk: Hard Disk, Network: Network. If this field is not specified, the system default boot order will be used (HardDisk, CdRom, Network)

  • systemTagsList

    System Tag

  • userTagsList

    User Tag

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null when the operation is successful. For details, see error

    • codeStringRequired

      Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause. The source error that caused the current error. If there is no original error, this field is null

  • inventoryVmInstanceInventoryRequired

    For details, see inventory

    • uuidStringRequired

      Resource UUID, uniquely identifying the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Resource description

    • zoneUuidStringRequired

      Data Center UUID

    • clusterUuidStringRequired

      Cluster UUID

    • imageUuidStringRequired

      Image UUID

    • hostUuidStringRequired

      Host UUID

    • lastHostUuidStringRequired

      最近一次主机UUID。

    • instanceOfferingUuidStringRequired

      Instance Offering UUID

    • rootVolumeUuidStringRequired

      Root Volume UUID

    • platformStringRequired

      平台。

    • architectureStringRequired

      No description provided.

    • defaultL3NetworkUuidStringRequired

      No description provided.

    • typeStringRequired

      类型。

    • hypervisorTypeStringRequired

      No description provided.

    • memorySizeLongRequired

      内存大小。

    • cpuNumIntegerRequired

      No description provided.

    • cpuSpeedLongRequired

      No description provided.

    • allocatorStrategyStringRequired

      No description provided.

    • createDateTimestampRequired

      Create date

    • lastOpDateTimestampRequired

      Last update date

    • stateStringRequired

      当前状态。

    • guestOsTypeStringRequired

      No description provided.

    • vmNicsListRequired

      For details, see vmNics

      • uuidStringRequired

        Resource UUID, uniquely identifying the resource

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • l3NetworkUuidStringRequired

        L3 Network UUID

      • ipStringRequired

        来源IP地址。

      • macStringRequired

        No description provided.

      • hypervisorTypeStringRequired

        No description provided.

      • netmaskStringRequired

        No description provided.

      • gatewayStringRequired

        No description provided.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        IP version

      • driverTypeStringRequired

        No description provided.

      • internalNameStringRequired

        内部名称。

      • deviceIdIntegerRequired

        设备ID。

      • typeStringRequired

        类型。

      • stateStringRequired

        NIC status

      • createDateTimestampRequired

        Create date

      • lastOpDateTimestampRequired

        Last update date

      • usedIpsListRequired

        For details, see usedIps

        • uuidStringRequired

          Resource UUID, uniquely identifying the resource

        • ipRangeUuidStringRequired

          IP Range UUID

        • l3NetworkUuidStringRequired

          L3 Network UUID

        • ipVersionIntegerRequired

          IP version

        • ipStringRequired

          IP address

        • netmaskStringRequired

          Netmask

        • gatewayStringRequired

          Gateway address

        • usedForStringRequired

          已使用用于。

        • ipInLonglongRequired

          No description provided.

        • vmNicUuidStringRequired

          Virtual Machine NIC UUID

        • createDateTimestampRequired

          Create date

        • lastOpDateTimestampRequired

          Last update date

    • allVolumesListRequired

      For details, see allVolumes

      • uuidStringRequired

        Resource UUID, uniquely identifying the resource

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Resource description

      • primaryStorageUuidStringRequired

        Primary Storage UUID

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • diskOfferingUuidStringRequired

        Disk Offering UUID

      • rootImageUuidStringRequired

        Root Image UUID

      • installPathStringRequired

        Disk install path on Primary Storage

      • typeStringRequired

        Disk type, data disk or root disk

      • formatStringRequired

        Disk format

      • sizeLongRequired

        Disk size

      • actualSizeLongRequired

        Disk actual size

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        Disk state

      • statusStringRequired

        Disk status

      • createDateTimestampRequired

        Create date

      • lastOpDateTimestampRequired

        Last update date

      • isShareableBooleanRequired

        Whether the disk is shareable

      • volumeQosStringRequired

        Disk QoS, format such as total=1048576

      • lastDetachDateTimestampRequired

        最近一次detach时间。

      • lastVmInstanceUuidStringRequired

        最近一次云主机实例UUID。

    • vmCdRomsListRequired

      For details, see vmCdRoms

      • uuidStringRequired

        Resource UUID, uniquely identifying the resource

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • deviceIdIntegerRequired

        设备ID。

      • isoUuidStringRequired

        No description provided.

      • isoInstallPathStringRequired

        iso安装路径。

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Resource description

      • createDateTimestampRequired

        Create date

      • lastOpDateTimestampRequired

        Last update date

Endpoint

PUT/zstack/v1/vm-instances/{uuid}/actions

/zstack/v1/vm-instances/{uuid}/actions

Operation ID

SetVmBootOrder

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/vm-instances/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"setvmbootorder":{"bootOrder":["<bootOrder>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "16a1759999f43522989d50257c148f03", "name": "Test-VM", "description": "web server VM", "zoneUuid": "52c0c4d3965330c78035324338caca26", "clusterUuid": "0d18aab547103bcfb2098655bd1fc71b", "imageUuid": "f2a2344a96a93d84958cdd8e9396ac53", "hostUuid": "fbd24b0405723d06b41fb0d41d126a53", "lastHostUuid": "3e0502a12a413e5a8cea8022d774e8f7", "instanceOfferingUuid": "bac644877b783182ace705f49d8b0d5d", "rootVolumeUuid": "963beb34a38a31c6a663861152ebdfa7", "platform": "Linux", "defaultL3NetworkUuid": "58e3259d7ac63196bab7b4fde66a63e4", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8589934592, "cpuNum": 1, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Stopped", "vmNics": [ { "uuid": "843c879cfd36341a845551d4f3f80adc", "vmInstanceUuid": "16a1759999f43522989d50257c148f03", "usedIpUuid": "34e14b0d570930bbaf521e6cf11703ad", "l3NetworkUuid": "58e3259d7ac63196bab7b4fde66a63e4", "ip": "192.168.1.10", "mac": "00:0c:29:bd:99:fc", "hypervisorType": "KVM", "netmask": "255.255.255.0", "gateway": "192.168.1.1", "deviceId": 0, "state": "enable", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "allVolumes": [ { "uuid": "963beb34a38a31c6a663861152ebdfa7", "name": "Root-Volume-For-VM-16a1759999f43522989d50257c148f03", "primaryStorageUuid": "bb0ef0006c0831bcba36bf8cb449e4e5", "vmInstanceUuid": "16a1759999f43522989d50257c148f03", "diskOfferingUuid": "d3208f0181f1312b8807e228e1f89bc9", "rootImageUuid": "f2a2344a96a93d84958cdd8e9396ac53", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-963beb34a38a31c6a663861152ebdfa7/963beb34a38a31c6a663861152ebdfa7.qcow2", "type": "Root", "format": "qcow2", "size": 107374182400, "actualSize": 21474836480, "deviceId": 0, "state": "Enabled", "status": "Ready", "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