API Reference | 5.5.30 | ZStack Cloud · ZCF

API Request

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setVmEmulatorPinning": {
    "emulatorPinning": "1-4"
  },
  "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 '{"setVmEmulatorPinning":{"emulatorPinning":"1-4"}}' http://localhost:8080/zstack/v1/vm-instances/f523cb5736b630acb643dda6d31be5a0/actions

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The resource UUID.	4.3.12
emulatorPinning	String	body(contained in the setVmEmulatorPinning structure)	The emulator pinning. Format: (\^?(\d+)(-\d+)?,)+. For example: (0-1,16)	4.3.12
systemTags	List	body	Optional. The system tags.	4.3.12
userTags	List	body	Optional. The user tags.	4.3.12

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

SetVmEmulatorPinningAction action = new SetVmEmulatorPinningAction();
action.uuid = "f523cb5736b630acb643dda6d31be5a0";
action.enable = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetVmEmulatorPinningAction.Result res = action.call();

Python SDK

SetVmEmulatorPinningAction action = SetVmEmulatorPinningAction()
action.uuid = "f523cb5736b630acb643dda6d31be5a0"
action.enable = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetVmEmulatorPinningAction.Result res = action.call()