API Reference | 5.5.30 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/guesttools
GET zstack/v1/guesttools/state

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/guesttools

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/guesttools/state

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using the CLI command tool, entering QueryGuestToolsState, and pressing the Tab key.

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

SDK Sample

Java SDK

QueryGuestToolsStateAction action = new QueryGuestToolsStateAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryGuestToolsStateAction.Result res = action.call();

Python SDK

QueryGuestToolsStateAction action = QueryGuestToolsStateAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryGuestToolsStateAction.Result res = action.call()