GCO Health Monitor API — API spec sheet¶
Service health-monitor · OpenAPI 3.1.0 · API version 1.0.0 · 6 endpoints · 0 schemas
Health monitoring service for GCO (Global Capacity Orchestrator on AWS) EKS clusters
- Machine-readable document:
docs/openapi/health-monitor.json— the FastAPIapp.openapi()export (scripts/generate_openapi.py) this sheet is rendered from - Interactive console (Swagger UI): https://aws-solutions-library-samples.github.io/global-capacity-orchestrator-on-aws/swagger/health-monitor/
- Catalogue index: README.md · interaction diagram
Endpoints¶
| Method | Path | Summary | Tags |
|---|---|---|---|
GET |
/ |
Root | — |
GET |
/api/v1/health |
Health Check | — |
GET |
/api/v1/metrics |
Get Metrics | — |
GET |
/api/v1/status |
Get Status | — |
GET |
/healthz |
Kubernetes Health Check | — |
GET |
/readyz |
Kubernetes Readiness Check | — |
Endpoint details¶
GET /¶
Root endpoint with basic service information
- Operation ID:
root__get
Responses
| Status | Description | Content |
|---|---|---|
200 |
Successful Response | application/json: object (free-form) |
GET /api/v1/health¶
Primary health check endpoint for ALB health checks Returns 200 if cluster is healthy, 503 if unhealthy
- Operation ID:
health_check_api_v1_health_get
Responses
| Status | Description | Content |
|---|---|---|
200 |
Successful Response | application/json: any |
GET /api/v1/metrics¶
Detailed metrics endpoint with resource utilization information
- Operation ID:
get_metrics_api_v1_metrics_get
Responses
| Status | Description | Content |
|---|---|---|
200 |
Successful Response | application/json: object (free-form) |
GET /api/v1/status¶
Service status endpoint with operational information
- Operation ID:
get_status_api_v1_status_get
Responses
| Status | Description | Content |
|---|---|---|
200 |
Successful Response | application/json: object (free-form) |
GET /healthz¶
Kubernetes-style health check endpoint Simple endpoint that returns 200 if the service is running
- Operation ID:
kubernetes_health_check_healthz_get
Responses
| Status | Description | Content |
|---|---|---|
200 |
Successful Response | application/json: object of string |
GET /readyz¶
Kubernetes-style readiness check endpoint Returns 200 if the service is ready to serve traffic
- Operation ID:
kubernetes_readiness_check_readyz_get
Responses
| Status | Description | Content |
|---|---|---|
200 |
Successful Response | application/json: object of string |
Schemas¶
This service declares no component schemas.