Describe a floating IP.

GET

/v1/projects/{projectId}/network/floating-ips/{floatingIPId}

Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/projects/example/network/floating-ips/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

projectId

required

string

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

floatingIPId

required

string

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

Responses

200

The FIP.

application/json

object

required

string

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

projectId

string

address

required

string format: ipv4

region

required

string

state

required

string

Allowed values: available allocated associated releasing released error

associatedNICId

The network interface this FIP is associated with. Empty for a FIP owned by a NAT gateway, a resolver inbound endpoint, a Client VPN endpoint or a load balancer — those express the association through their own field below, so a client must not treat this as “the” association.

string

associatedNATGWId

The NAT gateway whose external address this FIP is. Empty otherwise.

string

associatedRIEId

The resolver inbound endpoint this FIP fronts. Empty when the FIP fronts no endpoint. Read-only convenience on the Get/List read models.

string

associatedClientVpnId

The Client VPN endpoint this FIP is the public ingress of. Empty when the FIP fronts no endpoint. Keeps the FIP in state: associated so it cannot be released or hijacked while a terminator uses it. Read-only convenience on the Get/List read models.

string

associatedLoadBalancerId

The internet-facing load balancer this FIP fronts, resolved one-hop from the LB association. Empty when the FIP fronts no LB. Read-only convenience on the Get/List read models.

string

tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object

<= 50 properties

key

additional properties

string

<= 256 characters

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

createdBy

string

Example

{
  "state": "available"
}

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