VM Related Interfaces

Get Latest Guest Tools For VM

GET/zstack/v1/vm-instances/{uuid}/latest-guest-tools

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/f7be56d67fb731ac9e201c69428c6a69/latest-guest-tools

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
uuidStringurlResource UUID, uniquely identifies the resource 3.7.0
systemTags (Optional)ListquerySystem Tag 3.7.0
userTags (Optional)ListqueryUser Tag 3.7.0

API Response

Response Example

{
  "inventory": {
    "uuid": "281ed8f30eff42c4a8d788384b782977",
    "managementNodeUuid": "9fbb4361b1e2466f933558d45746bb59",
    "architecture": "x86_64",
    "hypervisorType": "kvm",
    "version": "1.0.0",
    "createDate": "Oct 9, 2019 7:37:57 PM",
    "lastOpDate": "Oct 9, 2019 7:37:57 PM"
  }
}
NameTypeDescriptionStarting Version
successbooleanSuccess3.7.0
errorErrorCodeError code. If not null, the operation failed. When the operation succeeds, this field is null. For details, see error3.7.0
inventoryGuestToolsInventoryFor details, see inventory3.7.0

error

NameTypeDescriptionStarting Version
codeStringError code number, a globally unique identifier of the error, for example SYS.1000, HOST.10013.7.0
descriptionStringBrief description of the error3.7.0
detailsStringDetailed error information3.7.0
elaborationStringReserved field, defaults to null3.7.0
opaqueLinkedHashMapReserved field, defaults to null3.7.0
causeErrorCodeRoot cause. The error that triggered the current error. If there is no original error, this field is null3.7.0

inventory

NameTypeDescriptionStarting Version
uuidStringResource UUID, uniquely identifies the resource3.7.0
nameStringResource name3.7.0
descriptionStringResource description3.7.0
managementNodeUuidStringManagement Node UUID3.7.0
architectureStringArchitecture3.7.0
hypervisorTypeStringHypervisor type3.7.0
versionStringVersion3.7.0
createDateTimestampCreate time3.7.0
lastOpDateTimestampLast update time3.7.0

SDK Examples

Java SDK

GetLatestGuestToolsForVmAction action = new GetLatestGuestToolsForVmAction();
action.uuid = "f7be56d67fb731ac9e201c69428c6a69";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetLatestGuestToolsForVmAction.Result res = action.call();

Python SDK

GetLatestGuestToolsForVmAction action = GetLatestGuestToolsForVmAction()
action.uuid = "f7be56d67fb731ac9e201c69428c6a69"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetLatestGuestToolsForVmAction.Result res = action.call()