Retrieve a load-balancer

GET 
/api/v1/services/:service_id/load-balancers/:id/

Gets a specific load-balancer.

Request

Path Parameters

id uuidrequired
service_id uuidrequired

Responses

200

application/json

Schema

Schema

custom_rules

object[]

required

Array [

id uuidrequired

load_balancer uuidrequired

matching_rule required

name stringrequired

Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9_\-\s]*$

origin_set uuidrequired

origin_set_name stringrequired

priority int64nullable

Possible values: >= -9223372036854776000 and <= 9223372036854776000

]

id uuidrequired
name stringrequired

Possible values: <= 255 characters, Value must match regular expression ^[a-zA-Z0-9_\-\s]*$

origin_sets

object[]

required

Array [

name stringrequired

origin_set uuidrequired

origins stringrequired

weight integer

Possible values: <= 255

]

service uuidrequired
type LoadBalancerTypeEnum (string)required
Possible values: [weighted]
• weighted - Weighted

Example (from schema)

{
  "custom_rules": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "load_balancer": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "matching_rule": {},
      "name": "string",
      "origin_set": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "origin_set_name": "string",
      "priority": 0
    }
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "origin_sets": [
    {
      "name": "string",
      "origin_set": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "origins": "string",
      "weight": 0
    }
  ],
  "service": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "weighted"
}

Loading...