Skip to content
StratumStratum Docs

Describe an LB's data-plane replicas.

GET
/v1/projects/{projectId}/lb/load-balancers/{loadBalancerId}/replicas
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/lb/load-balancers/example/replicas \
  --header 'Authorization: Bearer <token>'

The data-plane replica set standing behind the load balancer plus its HA / VIP front door. Reports the reconciler’s converged placement; an LB that is still provisioning returns an empty replica set.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/
loadBalancerId
required
string
/^lb-[a-z0-9]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The LB’s data-plane replicas.

Media typeapplication/json

The data-plane replica set behind a load balancer plus its HA / VIP front door. Sourced from the reconciler’s converged placement.

object
loadBalancerId
required
string
highAvailability
required

True when the LB runs more than one replica behind an OVN data-plane VIP; false for a single-replica LB.

boolean
vip

The VIP-fronted floating IP (the HA front door) when highAvailability. Empty for single-replica LBs — reach those via the replica’s floatingIp.

string
replicaCount
required
integer
replicas
required
Array<object>

One placed data-plane container.

object
containerId
required
string
nodeId
required
string
ip
required

The container address with the subnet mask stripped.

string
ipCidr
string
subnetId
string
state
required

The LB’s reconciled lifecycle state (provisioning / active / deleting). Per-container liveness is not probed yet, so every replica reports the LB-level state.

string
floatingIp

The replica’s own FIP in the single-replica case (associated to the container’s NIC rather than fronted by a VIP).

string

Example generated

{
  "loadBalancerId": "example",
  "highAvailability": true,
  "vip": "example",
  "replicaCount": 1,
  "replicas": [
    {
      "containerId": "example",
      "nodeId": "example",
      "ip": "example",
      "ipCidr": "example",
      "subnetId": "example",
      "state": "example",
      "floatingIp": "example"
    }
  ]
}

404

Section titled “404”

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}