tvpl.api

HealthCheckRequest

**Requires Authentication**
Required role:	super-admin

The following routes are available for this service:
GET	/system/health-check

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceHealthResult:
    name: Optional[str] = None
    status: Optional[str] = None
    response_time_ms: int = 0
    message: Optional[str] = None
    host: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthCheckResponse:
    services: Optional[List[ServiceHealthResult]] = None
    checked_at: datetime.datetime = datetime.datetime(1, 1, 1)
    background_services: Optional[HealthCheckResponse] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthCheckRequest:
    pass

Python HealthCheckRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /system/health-check HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	services: 
	[
		{
			name: String,
			status: String,
			responseTimeMs: 0,
			message: String,
			host: String
		}
	],
	backgroundServices: 
	{
		services: 
		[
			{
				name: String,
				status: String,
				responseTimeMs: 0,
				message: String,
				host: String
			}
		],
		backgroundServices: 
		{
			services: 
			[
				{
					name: String,
					status: String,
					responseTimeMs: 0,
					message: String,
					host: String
				}
			],
			backgroundServices: 
			{
				services: 
				[
					{
						name: String,
						status: String,
						responseTimeMs: 0,
						message: String,
						host: String
					}
				]
			}
		}
	}
}