Document navigation

PowerResetHost

API Request

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

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

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 '{"powerResetHost":{"returnEarly":false,"method":"AUTO"}}' //localhost:8080/zstack/v1/hosts/power/cbe0a6dc2b2b3dc9a84928f27461816b/actions

Request Parameters

Name Type Location Description Valid Values Starting Version
uuid String url The resource UUID. 4.7.0
method String body (contained in the powerResetHost structure) Optional. The method to reboot 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
returnEarly boolean body (contained in the powerResetHost structure) Optional. Whether to make the result returned eralier. 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

PowerResetHostAction action = new PowerResetHostAction();
action.uuid = "cbe0a6dc2b2b3dc9a84928f27461816b";
action.returnEarly = false;
action.method = "AUTO";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
PowerResetHostAction.Result res = action.call();

Python SDK

action = PowerResetHostAction()
action.uuid = "cbe0a6dc2b2b3dc9a84928f27461816b"
action.returnEarly = false
action.method = "AUTO"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()