| Required role: | super-admin |
| GET | /system/health-check |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class HealthCheckRequest
{
}
public static class HealthCheckResponse
{
public ArrayList<ServiceHealthResult> services = null;
public Date checkedAt = null;
public HealthCheckResponse backgroundServices = null;
public ArrayList<ServiceHealthResult> getServices() { return services; }
public HealthCheckResponse setServices(ArrayList<ServiceHealthResult> value) { this.services = value; return this; }
public Date getCheckedAt() { return checkedAt; }
public HealthCheckResponse setCheckedAt(Date value) { this.checkedAt = value; return this; }
public HealthCheckResponse getBackgroundServices() { return backgroundServices; }
public HealthCheckResponse setBackgroundServices(HealthCheckResponse value) { this.backgroundServices = value; return this; }
}
public static class ServiceHealthResult
{
public String name = null;
public String status = null;
public Long responseTimeMs = null;
public String message = null;
public String host = null;
public String getName() { return name; }
public ServiceHealthResult setName(String value) { this.name = value; return this; }
public String getStatus() { return status; }
public ServiceHealthResult setStatus(String value) { this.status = value; return this; }
public Long getResponseTimeMs() { return responseTimeMs; }
public ServiceHealthResult setResponseTimeMs(Long value) { this.responseTimeMs = value; return this; }
public String getMessage() { return message; }
public ServiceHealthResult setMessage(String value) { this.message = value; return this; }
public String getHost() { return host; }
public ServiceHealthResult setHost(String value) { this.host = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}
}
}
}