Skip to content
docs/API reference/FleetService

FleetService

The FleetService methods and their request and response messages.

≈ 5 minmarkdownedit on github ↗

Generated from fleet.proto. Every method is POST /rpc/engram.app.v1.FleetService/<Method> with a JSON or protobuf body and an x-api-key header.

Method Request Response
ListHosts ListHostsRequest ListHostsResponse
GetHost GetHostRequest GetHostResponse
RetireHost RetireHostRequest RetireHostResponse
DrainHost DrainHostRequest DrainHostResponse
AdminDrainHost AdminDrainHostRequest AdminDrainHostResponse
CordonHost CordonHostRequest CordonHostResponse
BeginHostHandoff BeginHostHandoffRequest BeginHostHandoffResponse
UncordonHost UncordonHostRequest UncordonHostResponse
DeleteHost DeleteHostRequest DeleteHostResponse
GetStorageSummary GetStorageSummaryRequest GetStorageSummaryResponse
TeleportSession TeleportSessionRequest TeleportSessionResponse
ChunkGc ChunkGcRequest ChunkGcResponse
BundleGc BundleGcRequest BundleGcResponse
SnapshotBlobGc SnapshotBlobGcRequest SnapshotBlobGcResponse
GetFleetDemand GetFleetDemandRequest GetFleetDemandResponse
Field Type
host_id string
Field Type
host_id string
planned repeated string
descended repeated string
skipped uint32
Field Type
host_id string
ttl_secs uint64
Field Type
host_id string
accepted bool
Field Type
dry_run bool
grace_secs uint64 (optional)
Field Type
listed uint64
pin_set_size uint64
candidates_marked uint64
promoted_deletes uint64
promote_delete_errors uint64
restart_count uint32
promote_repinned_skips uint64
Field Type
dry_run bool
grace_secs uint64 (optional)
Field Type
listed_chunks uint64
malformed_keys uint64
pin_set_size uint64
candidates_marked uint64
promoted_deletes uint64
promote_delete_errors uint64
grace_secs uint64
generation_moved bool
mark_error string (optional)
Field Type
host_id string
owner string
Field Type
host_id string
status string
Field Type
host_id string

No fields.

Field Type
host_id string

No fields.

No fields.

Field Type
ready_hosts uint32
schedulable_hosts uint32
free_mib uint64
total_mib uint64
free_vcpus uint64
total_vcpus uint64
cordoned_hosts uint32
queued_sessions uint64
queued_mib uint64
queued_vcpus uint64
Field Type
host_id string
Field Type
host HostView

No fields.

Field Type
snapshots uint64
snapshot_bytes uint64
gc_pending uint64
gc_pending_exact bool
Field Type
requested_at string
retired_at string
blockers repeated RetirementBlocker
Field Type
id string
hostname string
status string
capacity_total_mib uint64
capacity_used_mib uint64
running_sandboxes uint32
ready_images uint64
ready_image_digests repeated string
util_disk_total_mib uint64
util_disk_used_mib uint64
util_mem_total_mib uint64
util_mem_used_mib uint64
util_cpu_pct float
last_heartbeat_at string
cordoned bool
allocatable_mib uint64
reserved_mib uint64
free_mib uint64
total_vcpus uint32
cpu_budget_vcpus uint64
reserved_vcpus uint64
free_vcpus uint64
util_base_shm_mib uint64
util_parked_pss_mib uint64
util_running_pss_mib uint64
failing_capabilities repeated string
fc_snapshot_version string
capabilities_schema uint32
live_materializes uint32
live_capture_jobs uint32
cordon_owner string
retirement HostRetirement
pool_data_free_mib uint64
pool_data_total_mib uint64
pool_metadata_free_mib uint64
pool_metadata_total_mib uint64
reattach_generation uint32

No fields.

Field Type
hosts repeated HostView
Field Type
host_id string
owner string
reason string
Field Type
host_id string
retirement HostRetirement
teleports_planned uint32
Field Type
kind string
count uint64
Field Type
dry_run bool
grace_secs uint64 (optional)
Field Type
listed uint64
malformed uint64
pin_set_size uint64
candidates_marked uint64
promoted_deletes uint64
promote_repinned_skips uint64
promote_delete_errors uint64
restart_count uint32
Field Type
session_id string
target_host string (optional)
Field Type
teleport_id string
kind string
dest_host_id string
Field Type
host_id string
owner string
Field Type
host_id string
status string