RateLimiter

Rate Limiter object that contains peak, burst and cir. It can be associated with Egress QOS policy objects.

Overview

committedInformationRate string filterable   orderable  
description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
peakBurstSize string filterable   orderable  
peakInformationRate string 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 filterable   orderable  
Discussion

Committed Information Rate : Committed bandwidth that is allowed in Mb/s; only whole values supported.

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

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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 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 filterable   orderable  
Discussion

Peak Information Rate : Peak bandwidth allowed in Mb/s; only whole values supported.

Charateristics

Format: free
SDK attribute: peakInformationRate