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

{
  "setVmNuma": {
    "enable": true
  },
  "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 '{"setVmNuma":{"enable":true}}' http://localhost:8080/zstack/v1/vm-instances/f523cb5736b630acb643dda6d31be5a0/actions

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The VM UUID.	4.3.12
enable	boolean	body (contained in the setVmNum structure)body	Specifies whether to enable vNUMA for the VM instance.	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

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

Python SDK

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