设置虚拟机Emulator Pinning功能

PUT/zstack/v1/vm-instances/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/vm-instances/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/vm-instances/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setVmEmulatorPinning": {
    "emulatorPinning": ""
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"setVmEmulatorPinning":{"emulatorPinning":""}}' \
http://localhost:8080/zstack/v1/vm-instances/7bcde0f2638a3b83bb9120c17a7f34e1/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	4.3.12
emulatorPinning	String	body(包含在`setVmEmulatorPinning`结构中)		4.3.12
systemTags (可选)	List	body		4.3.12
userTags (可选)	List	body		4.3.12

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

SetVmEmulatorPinningAction action = new SetVmEmulatorPinningAction();
action.uuid = "7bcde0f2638a3b83bb9120c17a7f34e1";
action.emulatorPinning = "";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetVmEmulatorPinningAction.Result res = action.call();

Python SDK

SetVmEmulatorPinningAction action = SetVmEmulatorPinningAction()
action.uuid = "7bcde0f2638a3b83bb9120c17a7f34e1"
action.emulatorPinning = ""
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetVmEmulatorPinningAction.Result res = action.call()