RateLimiter

Set of traffic management parameters describing a desired traffic profile. Rate-limiters are used by QoS policies to enforce per Class of Server rate-conformance.

Overview

committedInformationRate string required   filterable   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
peakBurstSize string required   filterable   orderable  
peakInformationRate string required   filterable   orderable  

API Resource

/ratelimiters/id
delete get put

Parents

/enterprises/id/ratelimiters
get post
/ratelimiters
get post

Children

/ratelimiters/id/metadatas
get post
/ratelimiters/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

committedInformationRate string required   filterable   orderable  
Discussion

Committed Information Rate : Committed bandwidth that is allowed in Mb/s.


Charateristics

Format: free
SDK attribute: committedInformationRate

description string filterable   orderable  
Discussion

A description of the Rate Limiter object


Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

A unique name of the Rate Limiter object


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

peakBurstSize string required   filterable   orderable  
Discussion

Peak Burst Size : The maximum burst size associated with the rate limiter in kilo-bits; only whole values are supported.


Charateristics

Format: free
SDK attribute: peakBurstSize

peakInformationRate string required   filterable   orderable  
Discussion

Peak Information Rate : Peak bandwidth allowed in Mb/s.


Charateristics

Format: free
SDK attribute: peakInformationRate