Describe a load balancer.

GET

/v1/projects/{projectId}/lb/load-balancers/{loadBalancerId}

Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/projects/example/lb/load-balancers/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

projectId

required

string

/^p-[a-z0-9-]+$/

loadBalancerId

required

string

/^lb-[a-z0-9]+$/

Responses

200

The load balancer.

application/json

object

ownedBy

Set when a platform resource manages this row; absent on a tenant’s own.

object

kind

required

string

Allowed values: auto-scaling-group platform

required

The owner: the Auto Scaling group id, or for platform the component (front-door, pack:platform-health, default-network, operator-recipe).

string

required

string

/^lb-[a-z0-9]+$/

projectId

required

string

name

required

string

displayName

string

description

string

type

required

string

Allowed values: application

scheme

required

string

Allowed values: internet-facing internal

region

string

vpcId

required

string

subnetIds

Array<string>

securityGroupIds

Array<string>

floatingIpId

string

nullable

internalIp

string

nullable

dnsName

required

Synthesized stable name for this LB. NOT resolvable until a Stratum DNS service publishes it — check dnsPublished before using it.

string

dnsPublished

Whether dnsName is actually published to a resolver. Always false today (Stratum has no DNS service yet) — reach the LB via floatingIpId (internet-facing) or internalIp (internal). Flips per-LB once an LB-to-DNS publisher exists.

boolean

dataplaneIsolation

string

Allowed values: shared dedicated

generation

integer format: int64

tags

object

key

additional properties

any

state

required

string

stateReason

Why the load balancer is not active: the last placement failure, verbatim, or what it is waiting for once placed, such as its node’s report that the data-plane container runs and its floating IP is routed. Absent once active.

string

createdAt

string format: date-time

updatedAt

string format: date-time

createdBy

string

Example

{
  "ownedBy": {
    "kind": "auto-scaling-group"
  },
  "type": "application",
  "scheme": "internet-facing",
  "dataplaneIsolation": "shared"
}

404

Resource not found.

application/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"
    }
  ]
}