Help Center> ServiceStage> Developer Guide> Mesher> Admin API Definition> Health Check
View PDF

Health Check

Business Function

This API is used to check the health status of Mesher.

URI

GET /v1/mesher/health

Request

None

Response

Response Parameter

Table 1 describes the response parameters.

Table 1 Parameter description

Parameter

Type

Description

Health

health

Health status
Table 2 Health parameter description

Parameter

Type

Description

serviceName

string

Microservice name.

version

string

Microservice version.

status

string

The status can be green (healthy) or red (unhealthy). After being disconnected from the registration center, the status changes to red.

connectedConfigCenterClient

bool

Whether to connect to the configuration center.

connectedMonitoring

bool

Whether to connect to the CSE dashboard.

Response Example

{
    "serviceName": "cart",
    "version": "0.1",
    "status": "green",
    "connectedConfigCenterClient": false,
    "connectedMonitoring": false
}

Status Code

Table 3 describes the status code.

Table 3 Status code

Code

Description

200

Request succeeded.

500

Internal error.
Parent topic: Admin API Definition