Lexicon Garden

at.happyproto.admin.listHosts

Every host, with what its tenants hold. Staff only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityadmin.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Output

application/json

hosts

requiredarray
itemsref
Reference

unplaceablePlans

array

Plans open for new instances that fit on no active host, smallest first. A new instance on one of these fails with NoCapacity. Absent from a provisioner that does not report it.

itemsstring

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff, or the provisioner does not treat them as staff.

InvalidRequest

The provisioner refused the request as malformed. Not expected from this read; declared because every provisioner refusal is mapped the same way.

NotFound

Passed through from the provisioner.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

#host

object

A host. Never carries its addresses or agent certificate.

Properties

cpuMillis

requiredinteger

diskGb

requiredinteger

freeDiskGb

integer

diskGb less reservedDiskGb. Negative when the host is over-committed.

freeMemoryMb

integer

memoryMb less reservedMemoryMb. Negative when the host is over-committed.

id

requiredstring

A UUID.

lastSeenAt

string · datetime

When its agent last answered. Absent if it never has.

memoryMb

requiredinteger

name

requiredstring

placeablePlans

array

Plans open for new instances that fit in this host's free memory and disk, smallest first. Empty unless the host is active.

itemsstring

reservedDiskGb

requiredinteger

Disk held by the plans of instances placed here and not yet purged. A deleted instance keeps its disk through its recovery window.

reservedMemoryMb

requiredinteger

Memory those instances' plans hold.

state

requiredstring
  • knownValues: active | draining | degraded | retired

tenantCount

requiredinteger

Instances placed here and not deleted.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.