This section contains details about the QoS API commands and parameters. You can retrieve or configure each of these parameters using the get or set RESTful API commands.

Here is an example of a get command to retrieve the MaxConnsLimit parameter value:

/access/get?param=MaxConnsLimit

Here is an example of a set command to set the MaxConnsLimit to 80000:

/access/set?param=MaxConnsLimit&value=80000

The following limiting parameters can be retrieved or configured using the get or set commands:

  • MaxConnsLimit: The maximum number of simultaneous connections (TCP and UDP).

  • MaxCPSLimit: The global connection limit (per second).

  • MaxRPSLimit: The global request limit (per second).

  • MaxBandwidthLimit: The global bandwidth limit (kilobits per second)

  • SendRateLimitError: This parameter accepts the following values:
    • 0 - no error response (the connection is simply dropped)
    • 1 - Send 429 Too Many Requests error response
    • 2 - Send 503 Service Unavailable error response
  • RateLimitFail: Fail on rate limit. This parameter accepts the following values:
    • 0 - disabled (the LoadMaster attempts to select a different RS or SubVS to use for the connection)
    • 1 - enabled (forces an error)
  • LimitLogging: Generate a summary log entry every 5 seconds. This parameter accepts the following values:
    • 0 - disabled
    • 1 - enabled
  • ClientRepeatDelay: Set the minimum time after a client is no longer limited before a new message is generated. If a client generates a message and continues to be blocked for continuously hitting the limit, no new message is generated. Only if the client goes quiet for the delay period will a new message be generated. Valid values range from 10 - 86400 seconds.
  • ClientMaxConnsLimit: This limits the default maximum number of concurrent connection attempts (per second) from a specific host. Setting the limit to 0 disables this option. Valid values range from 0 - 1000000.
  • ClientCPSLimit: The global client connection limit.
  • ClientRPSLimit: The global client request limit.

  • ClientMaxBandwidthLimit: The global client maximum bandwidth limit.