v1

latestSwagger 2.02026-07-172964242.9 KB

Host

Get host

Returns information about a particular host in the cluster.

get/v1/hosts/{host_id}

Path parameters

host_idstring required

A user-specified identifier. Must be 1-36 characters, contain only lower-cased letters and hyphens, start and end with a letter or number, and not contain consecutive hyphens.

Response

OK response.

client_addressesstring[] required

The addresses that this host advertises to client applications.

cpusinteger

The number of CPUs on this host.

data_dirstring required

The data directory for the host.

etcd_mode'server' | 'client'

The etcd mode for this host.

idstring required

Unique identifier for the host.

memorystring

The amount of memory available on this host.

orchestratorstring required

The orchestrator used by this host.

peer_addressesstring[] required

The addresses that this host advertises to other hosts.

Example response

{
  "client_addresses": [
    "10.24.34.2",
    "i-0123456789abcdef.ec2.internal"
  ],
  "cohort": {
    "control_available": true,
    "member_id": "lah4bsznw6kc0hp7biylmmmll",
    "type": "swarm"
  },
  "cpus": 4,
  "data_dir": "/data",
  "default_pgedge_version": {
    "postgres_version": "17.6",
    "spock_version": "5"
  },
  "etcd_mode": "server",
  "id": "76f9b8c0-4958-11f0-a489-3bb29577c696",
  "memory": "16GiB",
  "orchestrator": "swarm",
  "peer_addresses": [
    "10.24.34.2",
    "i-0123456789abcdef.ec2.internal"
  ],
  "status": {
    "components": {
      "Id dolorem rerum labore commodi.": {
        "details": {
          "alarms": [
            "3: NOSPACE"
          ]
        },
        "error": "failed to connect to etcd",
        "healthy": false
      }
    },
    "state": "available",
    "updated_at": "2021-07-01T12:34:56Z"
  },
  "supported_pgedge_versions": [
    {
      "postgres_version": "17.6",
      "spock_version": "5"
    },
    {
      "postgres_version": "17.6",
      "spock_version": "5"
    },
    {
      "postgres_version": "17.6",
      "spock_version": "5"
    },
    {
      "postgres_version": "17.6",
      "spock_version": "5"
    }
  ]
}