GetLatestGuestToolsForVm
API Request
URLs
GET zstack/v1/vm-instances/{uuid}/latest-guest-toolsHeaders
Authorization: OAuth the-session-uuidCurl
Sample
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-toolsRequest Parameters
| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 3.7.0 | |
| systemTags | List | query | Optional. The system tags. | 3.7.0 | |
| userTags | List | query | Optional. The user tags. | 3.7.0 |
API Response
Sample
Response
{
"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"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | Whether the operation succeeds. | 3.7.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.7.0 |
| inventory | GuestToolsInventory | See inventory. | 3.7.0 |
#error
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 3.7.0 |
| description | String | The brief description of the error. | 3.7.0 |
| details | String | The details about the error. | 3.7.0 |
| elaboration | String | The reserved field. Default value: null. | 3.7.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 3.7.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 3.7.0 |
#inventory
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 3.7.0 |
| name | String | The resource name. | 3.7.0 |
| description | String | The detailed description of the resource. | 3.7.0 |
| managementNodeUuid | String | The management node UUID. | 3.7.0 |
| architecture | String | The architecture. | 3.7.0 |
| hypervisorType | String | The hypervisor type. | 3.7.0 |
| version | String | The version. | 3.7.0 |
| createDate | Timestamp | The creation date. | 3.7.0 |
| lastOpDate | Timestamp | The last operation date. | 3.7.0 |
SDK Sample
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()