Document navigation

GetVmNuma

API Request

URLs

GET zstack/v1/vm-instances/{uuid}/vnuma

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/1dd7af3a42403a1d9b3734f5ed573103/vnuma

Request Parameters

Name Type Location Description Optional Value Starting Version
uuid String url The VM UUID. 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,

{
  "enable": true
}
Name Type Description Starting Version
enable boolean Indicates whether vNUMA is enabled for the VM instance. 4.3.12
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 4.3.12

#error

Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 4.3.12
description String The brief description of the error. 4.3.12
details String The details about the error. 4.3.12
elaboration String The reserved field. Default value: null. 4.3.12
opaque LinkedHashMap The reserved field. Default value: null. 4.3.12
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 4.3.12

SDK Sample

Java SDK

GetVmNumaAction action = new GetVmNumaAction();
action.uuid = "1dd7af3a42403a1d9b3734f5ed573103";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmNumaAction.Result res = action.call();

Python SDK

action = GetVmNumaAction()
action.uuid = "1dd7af3a42403a1d9b3734f5ed573103"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()