Overview

Namespaces

  • None
  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Exceptions
      • Log
      • Request
        • Response
    • Compute
    • Database
    • DNS
    • LoadBalancer
      • Resources
    • ObjectStore
      • Resource
    • Orchestration
    • Volume
  • PHP

Classes

  • Access
  • Algorithm
  • AllowedDomain
  • BillableLoadBalancer
  • ConnectionLogging
  • ConnectionThrottle
  • ContentCaching
  • ErrorPage
  • HealthMonitor
  • LoadBalancer
  • Metadata
  • Node
  • NodeEvent
  • Protocol
  • Readonly
  • SessionPersistence
  • SSLTermination
  • Stats
  • SubResource
  • Usage
  • VirtualIp
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class ConnectionThrottle

The connection throttling feature imposes limits on the number of connections per IP address to help mitigate malicious or abusive traffic to your applications. The attributes in the table that follows can be configured based on the traffic patterns for your sites.

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\LoadBalancer\Resources\SubResource
Extended by OpenCloud\LoadBalancer\Resources\ConnectionThrottle
Namespace: OpenCloud\LoadBalancer\Resources
Located at OpenCloud/LoadBalancer/Resources/ConnectionThrottle.php
Methods summary
public HttpResponse
# create( array $params = array() )

create uses PUT like Update

create uses PUT like Update

Parameters

$params
array
$params array of values to set when creating the object

Returns

HttpResponse

Throws

VolumeCreateError
if HTTP status is not Success

Overrides

OpenCloud\Common\PersistentObject::create()
Methods inherited from OpenCloud\LoadBalancer\Resources\SubResource
CreateJson(), initialRefresh(), name(), updateJson(), url()
Methods inherited from OpenCloud\Common\PersistentObject
__construct(), __set(), action(), checkExtension(), createJson(), createUrl(), customAction(), delete(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), noCreate(), noDelete(), noUpdate(), parent(), primaryKeyField(), refresh(), region(), resourceName(), service(), setParent(), setService(), status(), update(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties summary
public integer $minConnections
#

Allow at least this number of connections per IP address before applying throttling restrictions. Setting a value of 0 allows unlimited simultaneous connections; otherwise, set a value between 1 and 1000.

Allow at least this number of connections per IP address before applying throttling restrictions. Setting a value of 0 allows unlimited simultaneous connections; otherwise, set a value between 1 and 1000.

public integer $maxConnections
#

Maximum number of connections to allow for a single IP address. Setting a value of 0 will allow unlimited simultaneous connections; otherwise set a value between 1 and 100000.

Maximum number of connections to allow for a single IP address. Setting a value of 0 will allow unlimited simultaneous connections; otherwise set a value between 1 and 100000.

public integer $maxConnectionRate
#

Maximum number of connections allowed from a single IP address in the defined rateInterval. Setting a value of 0 allows an unlimited connection rate; otherwise, set a value between 1 and 100000.

Maximum number of connections allowed from a single IP address in the defined rateInterval. Setting a value of 0 allows an unlimited connection rate; otherwise, set a value between 1 and 100000.

public integer $rateInterval
#

Frequency (in seconds) at which the maxConnectionRate is assessed. For example, a maxConnectionRate of 30 with a rateInterval of 60 would allow a maximum of 30 connections per minute for a single IP address. This value must be between 1 and 3600.

Frequency (in seconds) at which the maxConnectionRate is assessed. For example, a maxConnectionRate of 30 with a rateInterval of 60 would allow a maximum of 30 connections per minute for a single IP address. This value must be between 1 and 3600.

protected static string $json_name "connectionThrottle"
#
protected static string $url_resource "connectionthrottle"
#
protected array $createKeys array( 'minConnections', 'maxConnections', 'maxConnectionRate', 'rateInterval' )
#
Properties inherited from OpenCloud\Common\PersistentObject
$id
PHP OpenCloud API API documentation generated by ApiGen 2.8.0