tvpl.api

<back to all web services

HealthCheckRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
GET/system/health-check
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using tvpl.api.ServiceModel;

namespace tvpl.api.ServiceModel
{
    public partial class HealthCheckRequest
    {
    }

    public partial class HealthCheckResponse
    {
        public HealthCheckResponse()
        {
            Services = new List<ServiceHealthResult>{};
        }

        public virtual List<ServiceHealthResult> Services { get; set; }
        public virtual DateTime CheckedAt { get; set; }
        public virtual HealthCheckResponse BackgroundServices { get; set; }
    }

    public partial class ServiceHealthResult
    {
        public virtual string Name { get; set; }
        public virtual string Status { get; set; }
        public virtual long ResponseTimeMs { get; set; }
        public virtual string Message { get; set; }
        public virtual string Host { get; set; }
    }

}

C# 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
					}
				]
			}
		}
	}
}