GetVipQos
API Request
URLs
GET zstack/v1/vip/{uuid}/vip-qos
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/vip/e7bd5b22962e33ba8608533f18f10bd1/vip-qos
Request Parameters
Name | Type | Location | Description | Optional Value | Starting Version |
---|---|---|---|---|---|
uuid | String | url | Optional. The resource UUID. | 2.3 | |
systemTags | List | query | Optional. The system tags. | 2.3 | |
userTags | List | query | Optional. The user tags. | 2.3 |
API Response
Sample
Response
{
"inventories": [
{
"uuid": "5a0b0e4ab75c4fffa890cf085add862f",
"vipUuid": "23349810e3874c2dad85042db1ac11dc",
"port": 80.0,
"inboundBandwidth": 1048576.0,
"outboundBandwidth": 1048576.0
}
]
}
Name | Type | Description | Starting Version |
---|---|---|---|
error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 2.3 |
inventories | List | See inventories. | 2.3 |
#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. | 2.3 |
description | String | The brief description of the error. | 2.3 |
details | String | The details about the error. | 2.3 |
elaboration | String | The reserved field. Default value: null. | 2.3 |
opaque | LinkedHashMap | The reserved field. Default value: null. | 2.3 |
cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 2.3 |
#inventories
Name | Type | Description | Starting Version |
---|---|---|---|
uuid | String | The resource UUID. | 2.3 |
vipUuid | String | The VIP UUID. | 2.3 |
port | Integer | The port. | 2.3 |
inboundBandwidth | Long | The outbound bandwidth of the response port. | 2.3 |
outboundBandwidth | Long | The inbound bandwidth of the response port. | 2.3 |
type | String | The QoS unit type. | 2.3 |
createDate | Timestamp | The creation date. | 2.3 |
lastOpDate | Timestamp | The last operation date. | 2.3 |
SDK Sample
Java
SDK
GetVipQosAction action = new GetVipQosAction();
action.uuid = "e7bd5b22962e33ba8608533f18f10bd1";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVipQosAction.Result res = action.call();
Python
SDK
GetVipQosAction action = GetVipQosAction()
action.uuid = "e7bd5b22962e33ba8608533f18f10bd1"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVipQosAction.Result res = action.call()