Media Type: [application/vnd.org.midonet.QOSRuleBWLimit-v1+json]
GET /qos_policies/:qosPolicyId/qos_bw_limit_rules GET /qos_bw_limit_rules/:ruleId POST /qos_policies/:qosPolicyId/qos_bw_limit_rules PUT /qos_bw_limit_rules/:ruleId DELETE /qos_bw_limit_rules/:ruleId
A QoS Bandwidth Limit Rule represents a QoS rule in MidoNet which will govern how bandwidth is limited to actual network traffic. It contains the following fields:
Field Name | Type | POST/PUT | Required | Description |
---|---|---|---|---|
uri | URI | A GET against this URI refreshes the representation of this resource. | ||
policyId | UUID | The identifier of the QoS policy to which the rule belongs. | ||
id | UUID | POST | A unique identifier of the resource. If this field is omitted in the POST request, a random UUID is generated. | |
maxKbps | Integer | POST/PUT | Yes | The maximum speed for traffic on a port which has a policy which uses this rule. This isn’t a hard value and is basically an average maximum over time, although sustained traffic speeds higher than this value will result in dropped packets. |
maxBurstKb | Integer | POST | No | The maximum size for a packet to be allowed through any port which has a policy which uses this rule. If a packet size is greater than this value, it will be rejected. If omitted, a value of 80% of the maxKbps is used as a default. |