load-balancing_load_shedding

Configures load shedding policies and percentages for the pool.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
default_percent	number	The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
default_policy	string	The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests origina
session_percent	number	The percent of existing sessions to shed from the pool, according to the session policy.
session_policy	string	Only the hash policy is supported for existing sessions (to avoid exponential decay).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/load-balancing_load_shedding",
  "title": "load-balancing_load_shedding",
  "description": "Configures load shedding policies and percentages for the pool.",
  "properties": {
    "default_percent": {
      "default": 0,
      "description": "The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "default_policy": {
      "default": "random",
      "description": "The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.",
      "enum": [
        "random",
        "hash"
      ],
      "type": "string"
    },
    "session_percent": {
      "default": 0,
      "description": "The percent of existing sessions to shed from the pool, according to the session policy.",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "session_policy": {
      "default": "hash",
      "description": "Only the hash policy is supported for existing sessions (to avoid exponential decay).",
      "enum": [
        "hash"
      ],
      "type": "string"
    }
  },
  "type": "object"
}