UpdateVmPriority
API Request
URLs
PUT zstack/v1/vm-instances/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
"updateVmPriority": {
"priority": "High"
},
"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 '{"updateVmPriority":{"priority":"High"}}' http://localhost:8080/zstack/v1/vm-instances/f308c452113832df898fb62ea87b2afc/actions
Request Parameters
| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 3.7.0 | |
| priority | String | body (contained in the updateVmPriority structure) | The priority. | 3.7.0 | |
| systemTags | List | body | Optional. The system tags. | 3.7.0 | |
| userTags | List | body | Optional. The user tags. | 3.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
UpdateVmPriorityAction action = new UpdateVmPriorityAction();
action.uuid = "f308c452113832df898fb62ea87b2afc";
action.priority = "High";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateVmPriorityAction.Result res = action.call();
Python SDK
action = UpdateVmPriorityAction()
action.uuid = "f308c452113832df898fb62ea87b2afc"
action.priority = "High"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()
