Skip to main content
GET
https://sajuapi.dev
/
v1
/
health
헬스 체크
curl --request GET \
  --url https://sajuapi.dev/v1/health \
  --header 'X-API-Key: <api-key>'
v1 Enterprise API (Coming Soon)이 엔드포인트는 Enterprise 버전에서 제공될 예정입니다. 현재는 v0 API를 사용하세요.
서비스의 기본 상태를 확인합니다. 로드 밸런서의 헬스 체크나 간단한 연결 확인에 사용합니다.
이 엔드포인트는 인증 없이 호출할 수 있습니다. 상세한 서비스 상태는 /v1/status 엔드포인트를 사용하세요.

Response

성공

서비스가 정상이면 200 OK와 함께 상태 정보가 반환됩니다.

실패

상태 코드에러 타입설명
503service_unavailable서비스를 사용할 수 없음

요청 예시

curl -X GET https://api.sajuapi.dev/v1/health

응답 예시

정상

{
  "status": "healthy",
  "timestamp": "2025-01-16T09:00:00Z"
}

비정상

{
  "status": "unhealthy",
  "timestamp": "2025-01-16T09:00:00Z"
}

Health 객체

필드타입설명
statusstring서비스 상태입니다. healthy 또는 unhealthy입니다.
timestampstring응답 생성 시간입니다.

활용 사례

Kubernetes Liveness Probe

livenessProbe:
  httpGet:
    path: /v1/health
    port: 3000
  initialDelaySeconds: 10
  periodSeconds: 30
  timeoutSeconds: 5
  failureThreshold: 3

AWS ALB Health Check

Health check path: /v1/health
Healthy threshold: 2
Unhealthy threshold: 3
Timeout: 5 seconds
Interval: 30 seconds
Success codes: 200
헬스 체크 엔드포인트는 가볍게 유지되어 빠른 응답 시간을 보장합니다. 데이터베이스 연결 상태 등 상세 정보가 필요하면 /v1/status를 사용하세요.