ShutdownHost

API Request

URLs

PUT zstack/v1/hosts/power/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "shutdownHost": {
    "returnEarly": false,
    "force": false,
    "method": "AUTO"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"shutdownHost":{"returnEarly":false,"force":false,"method":"AUTO"}}' //localhost:8080/zstack/v1/hosts/power/700457ff11133edf93541013f6caf8e7/actions

Request Parameters

Name	Type	Location	Description	Valid Value	Starting Version
uuid	String	url	The resource UUID.		4.7.0
returnEarly	boolean	body (contained in the shutdownHost structure)	Optional. Whether to make the result returned eralier.		4.7.0
force	boolean	body (contained in the shutdownHost structure)	Optional. Whether to forcefully power off the host.		0.6
method	String	body (contained in the shutdownHost structure)	Optional. The method to power off the host.	AUTO AGENT IPMI	4.7.0
systemTags	List	body	Optional. The system tags.		4.7.0
userTags	List	body	Optional. The user tags.		4.7.0

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

ShutdownHostAction action = new ShutdownHostAction();
action.uuid = "700457ff11133edf93541013f6caf8e7";
action.returnEarly = false;
action.force = false;
action.method = "AUTO";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ShutdownHostAction.Result res = action.call();

Python SDK

ShutdownHostAction action = ShutdownHostAction()
action.uuid = "700457ff11133edf93541013f6caf8e7"
action.returnEarly = false
action.force = false
action.method = "AUTO"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ShutdownHostAction.Result res = action.call()

PreviousPowerResetHost NextUpdateHostIpmi