API Reference | ZStack ZSphere · ZVF | ZStack Resource Center

API Request

URLs

GET zstack/v1/vm-instances/{uuid}/nic-qos

Headers

Authorization: OAuth the-session-uuid

Curl Example

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

Parameter List

Name	Type	Location	Description	Starting Version
uuid	String	url	UUID of the Virtual Machine NIC	0.6
systemTags (Optional)	List	query	Optional. The system tags.	0.6
userTags (Optional)	List	query	Optional. The user tags.	0.6

API Response

Response Example

{
  "outboundBandwidth": 100000.0,
  "inboundBandwidth": 200000.0,
  "outboundBandwidthUpthreshold": 300000.0,
  "inboundBandwidthUpthreshold": 300000.0

}

Name	Type	Description	Starting Version
outboundBandwidth	long	The outbound bandwidth.	0.6
inboundBandwidth	long	The inbound bandwidth.	0.6
success	boolean	Whether the operation succeeded.	0.6
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation is successful. For details, see error	0.6

#error

Name	Type	Description	Starting Version
code	String	Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed error information	0.6
elaboration	String	Reserved field, defaults to null	0.6
opaque	LinkedHashMap	Reserved field, defaults to null	0.6
cause	ErrorCode	Root cause. The source error that caused the current error. If there is no original error, this field is null	0.6

SDK Examples

Java SDK

GetNicQosAction action = new GetNicQosAction();
action.uuid = "479590eada5337caa477f4a604f1016b";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetNicQosAction.Result res = action.call();

Python SDK

GetNicQosAction action = GetNicQosAction()
action.uuid = "479590eada5337caa477f4a604f1016b"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetNicQosAction.Result res = action.call()