VM Related Interfaces

Get Virtual Machine Boot Order

GET/zstack/v1/vm-instances/{uuid}/boot-orders

Get the boot device list of a Virtual Machine.

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth: 458995c072644d28b32b26f69e512c2c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/426cff83f17d4a5aa7c752484d730f20/boot-orders

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
uuidStringurlVirtual Machine UUID 0.6
systemTags (Optional)ListquerySystem Tag 0.6
userTags (Optional)ListqueryUser Tag 0.6

API Response

Response Example

{
  "order": [
    "HardDisk",
    "CdRom"
  ]
}
NameTypeDescriptionStarting Version
successboolean 0.6
ordersListBoot device list0.6
errorErrorCodeError code. If not null, the operation failed. This field is null when the operation is successful. For details, see error0.6

error

NameTypeDescriptionStarting Version
codeStringError code number, a globally unique identifier for the error, for example SYS.1000, HOST.10010.6
descriptionStringBrief description of the error0.6
detailsStringDetailed error information0.6
elaborationStringReserved field, defaults to null0.6
opaqueLinkedHashMapReserved field, defaults to null0.6
causeErrorCodeRoot cause. The source error that caused the current error. If there is no original error, this field is null0.6

SDK Examples

Java SDK

GetVmBootOrderAction action = new GetVmBootOrderAction();
action.uuid = "914ab429715b40d59efa76c1ccfe64d8";
action.sessionId = "0472be4a6e2c4e7c9d7bcf3da2938313";
GetVmBootOrderAction.Result res = action.call();

Python SDK

GetVmBootOrderAction action = GetVmBootOrderAction()
action.uuid = "cba88e6e561049c8b7beaeccf4d46279"
action.sessionId = "bd37fd5e33e847d4bef4bb536d6410ea"
GetVmBootOrderAction.Result res = action.call()