Site Hosts Summary

Summary of the hosts for a site.

Retrieve the hosts summary

SecurityaccessToken
Request
path Parameters
site-summary-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of the site.

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/site-status/sites/{site-summary-name}/hosts-summary
Response samples
hosts:
  - host-id: 23dfc749-ca94-4341-8ca0-ce108e20ce6b
    cluster-hostname: udc1-001
    hostname: h04
    controller: true
    distress: disaster-mode
    distress-info: System in disaster mode.
    distress-updated-at: 2023-03-14T16:31:30.296Z
    version: dev-ff7b2dfc
    maintenance-mode: off
    quarantined: false
  - host-id: 62d7b2a2-b3ec-4c67-818e-74eb9a7241b6
    cluster-hostname: udc1-002
    hostname: h05
    controller: true
    distress: disk-threshold-reached
    distress-info: The level of disk usage has put the host in distress.
    distress-updated-at: 2023-03-14T16:31:24.075Z
    version: dev-ff7b2dfc
    maintenance-mode: off
    quarantined: false
  - host-id: 755723c8-fc5d-4453-a297-452cfdbbd583
    cluster-hostname: udc1-003
    hostname: h06
    controller: true
    distress: down
    distress-info: The host is down.
    distress-updated-at: 2023-03-14T16:31:30.296Z
    version: dev-ff7b2dfc
    maintenance-mode: off
    quarantined: false