Health
- Last UpdatedJul 23, 2024
- 2 minute read
APIs related to querying service health states
Get Tenant Health
Returns tenant health data. Data contains an aggregated health state and list of tenant related services.
Request
GET /api/v1/tenants/{tenantId}/health
Parameters
string tenantId
Tenant identifer
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | TenantViewModel | Health data for the requested tenant |
| 400 | ErrorResponse | Missing or invalid inputs |
| 401 | None | Unauthorized |
| 403 | ErrorResponse | Forbidden |
| 500 | ErrorResponse | Internal server error |
Example response body
200 Response
{
"HealthState": 0,
"Namespaces": [
{
"NamespaceId": "string",
"Region": "string",
"HealthState": 0,
"Services": [
{
"Name": "string",
"HealthState": null
}
]
}
],
"Regions": [
{
"Region": "string",
"Name": "string",
"HealthState": 0
}
]
}
Definitions
TenantViewModel
This represents a view model of a TenantDbo
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| HealthState | State | false | false | Health state of the tenant |
| Namespaces | [NamespaceViewModel] | false | true | Namespaces scoped to this tenant |
| Regions | [RegionDto] | false | true | Features scoped to this tenant |
{
"HealthState": 0,
"Namespaces": [
{
"NamespaceId": "string",
"Region": "string",
"HealthState": 0,
"Services": [
{
"Name": "string",
"HealthState": null
}
]
}
],
"Regions": [
{
"Region": "string",
"Name": "string",
"HealthState": 0
}
]
}
State
Represents the various health states a HealthEventViewModel can represent.
Enumerated Values
| Property | Value |
|---|---|
| Invalid | 0 |
| Ok | 1 |
| Warning | 2 |
| Error | 3 |
| Unknown | 65535 |
NamespaceViewModel
Object for a namespace and underlying services
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| NamespaceId | string | false | true | Namespace identifier |
| Region | string | false | true | Namespace region |
| HealthState | State | false | false | Health state of the namespace |
| Services | [ServiceForTenantViewModel] | false | true | Services scoped to the namespace |
{
"NamespaceId": "string",
"Region": "string",
"HealthState": 0,
"Services": [
{
"Name": "string",
"HealthState": 0
}
]
}
ServiceForTenantViewModel
This represents a view model of a ServiceForTenantDbo
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Name | string | false | true | Name of the service |
| HealthState | State | false | false | Health state of the service |
{
"Name": "string",
"HealthState": 0
}
RegionDto
The health for a suite of services representing a CONNECT data services capability within a region.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Region | string | false | true | Region in which the services are located. |
| Name | string | false | true | Name for the CONNECT data services capability facilitated by the region scoped services. |
| HealthState | State | false | false | Health state of the region scoped services. |
{
"Region": "string",
"Name": "string",
"HealthState": 0
}
ErrorResponse
Object used to represent error information
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | Operation Id of the action that caused the error |
| Error | string | false | true | Error description |
| Reason | string | false | true | Reason for the error |
| Resolution | string | false | true | Resolution for the error |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string"
}