API Reference | 5.5.30 | ZStack Cloud · ZCF

API Request

URLs

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

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/21529457e42c30f0a9b2a137915a0b28/vnuma-topology

Request Parameters

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

{
        "hostUuid": "7fd86bbe6ca94a8d810aa1d33e29932c",
        "topology": [
            {
                "CPUsID": ["0", "1", "2", "3"],
                "distance": ["10", "21"],
                "nodeID": 0,
                "memSize": 1024,
                "phyNodeID": 0
            },
            {
                "CPUsID": ["4", "5", "6", "7"],
                "distance": ["21", "10"],
                "nodeID": 1,
                "memSize": 2048,
                "phyNodeID": 1
            }
        ],
        "name": "vm0",
        "uuid": "71b30db8bca34e9191ed09bff2990e80"
    }

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	4.3.12
name	String	The VM name.	4.3.12
uuid	String	The VM UUID.	4.3.12
hostUuid	String	The host UUID.	4.3.12
topology	array[json]	The vNUMA topology. For more information, see topology.	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

#topology

Name	Type	Description	Starting Version
nodeID	int	The vNUMA node ID.	4.3.12
CPUsID	array[string]	The vCPU IDs in the vNUMA node.	4.3.12
phyNodeID	int	The pNUMA node ID.	4.3.12
distance	array[string]	The distance information of the vNUMA node.	4.3.12
memSize	long	The memory size of the vNUMA node, in the unit of B.	4.3.12

SDK Sample

Java SDK

GetVmvNUMATopologyAction action = new GetVmvNUMATopologyAction()
action.uuid ="ff6d905e75d63e18ab0a9fc2ac14951c"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVmvNUMATopologyAction.Result res = action.call()

Python SDK

GetVmvNUMATopologyAction action = new GetVmvNUMATopologyAction()
action.uuid ="ff6d905e75d63e18ab0a9fc2ac14951c"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVmvNUMATopologyAction.Result res = action.call()