Read the availability of a storage

GET

/api/managed-storage/{id}/availability

curl --request GET \
  --url https://opfield.example.com/api/managed-storage/550e8400-e29b-41d4-a716-446655440000/availability \
  --header 'Authorization: Bearer <token>'

• Your Opfield instance

Members in failover order (role, eligible, lag, sync state, last report), voters, witnesses, state with its reason, durability and its loss window, the running operation. 404 AVAILABILITY_SET_NOT_FOUND when the storage runs on one server. Needs storage:view. Keeps working on an existing set after the license grace period.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

setId

required

string format: uuid

mode

required

Automatic | manual. manual: a replicated pair without automatic failover (no witness host); make a copy primary by hand

string

state

required

Converting | healthy | degraded | no_failover | failing_over | closing | error | paused (the resource is paused)

string

stateReason

required

object

code

required

string

message

string

since

string

durability

required

Synchronous | asynchronous

string

durabilitySource

required

Auto | admin

string

lossWindowText

required

What an unplanned failover can lose with this durability

string

maxLagBytes

required

number

syncDegradeAfterSeconds

required

number

priorityMode

required

boolean

failbackDelaySeconds

required

number

rttP50Ms

required

number | null

rttMeasuredAt

required

string | null

primaryMemberId

required

string | null format: uuid

primarySince

required

string | null

primaryGeneration

required

number

members

required

Array<object>

object

id

required

string format: uuid

nodeId

required

string format: uuid

nodeName

required

string | null

priority

required

Failover preference: higher first, then the older member. members lists the servers in this order, which PUT availability/members/order sets

integer

role

required

Primary | copy | rebuilding | fenced | unknown

string

previousPrimary

required

It still reports itself primary but lost the role in a failover (role shows unknown until it reports)

boolean

eligible

required

Whether this copy may take over now

boolean

eligibilityReason

required

string | null

lagBytes

required

number | null

lagSeconds

required

number | null

syncState

required

Sync | async | none

string

status

required

Creating | ready | error | removing

string

desiredState

required

Member | removing

string

publishedPort

required

integer | null

lastError

required

string | null

lastReportedAt

required

string | null

reporting

required

The member reported recently

boolean

voters

required

Array<string>

witnesses

required

Array<object>

object

id

required

string format: uuid

purpose

required

Lease | keeper

string

hostKind

required

Relay | node

string

relayInstanceId

required

string | null format: uuid

nodeId

required

string | null format: uuid

role

required

Active | standby

string

status

required

string

missingForAutomatic

required

string | null

canLose

required

Servers the set can lose now and keep its primary role

number | null

lease

required

object

mode

required

string

degraded

required

boolean

reason

required

string | null

joint

required

boolean

holderNodeId

required

string | null

policyLeaseHours

required

How long failover keeps working while Opfield is down (the relay policy lease)

number | null

operation

required

object

id

required

string

kind

required

string

step

required

string

startedAt

required

string

lastError

required

string | null

connection

required

object

multiHostUri

required

string | null

hosts

required

Array<object>

object

memberId

required

string

host

required

string

port

required

number

changesBlocked

required

Set when the license no longer covers changes: turning on, adding servers, settings and the failover order are refused; everything else keeps working

string | null

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}