关闭物理机(ShutdownHost)

API请求

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: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

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

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	资源的UUID，唯一标示该资源		4.7.0
returnEarly (可选)	boolean	body(包含在shutdownHost结构中)	是否提前返回		4.7.0
force (可选)	boolean	body(包含在shutdownHost结构中)	是否强制关机		0.6
method (可选)	String	body(包含在shutdownHost结构中)	关机方式	AUTO AGENT IPMI	4.7.0
systemTags (可选)	List	body	系统标签		4.7.0
userTags (可选)	List	body	用户标签		4.7.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

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

SDK示例

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()

上一篇重启物理机(PowerResetHost)下一篇更新物理机IPMI信息(UpdateHostIpmi)