load-balancing_origin_steering

Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

APIs.ioEngineeringPlatform

Properties

Name Type Description
policy string The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-load-balancing-origin-steering-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/load-balancing_origin_steering",
  "title": "load-balancing_origin_steering",
  "description": "Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.",
  "properties": {
    "policy": {
      "default": "random",
      "description": "The type of origin steering policy to use.\n- `\"random\"`: Select an origin randomly.\n- `\"hash\"`: Select an origin by computing a hash over the CF-Connecting-IP address.\n- `\"least_outstanding_requests\"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.\n- `\"least_connections\"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.",
      "enum": [
        "random",
        "hash",
        "least_outstanding_requests",
        "least_connections"
      ],
      "type": "string"
    }
  },
  "type": "object"
}