Description
You can call this operation to query the status of the OCP application. It checks the status of each module of the OCP application and returns the health status of all modules.
Call description
Prerequisite
You have passed the authentication for the OCP application service.
Request path
GET /api/status
Request parameters
Parameter |
Type |
Required |
Example |
Description |
|---|---|---|---|---|
| includeUnavailableComponent | Boolean | No | true | Specifies whether to query the names of unavailable modules. |
Response parameters**
Simple text is returned.
The available status keyword of the API. The default value is okay.
The unavailable status keyword of the API. The default value is bad.
You can set the text returned in the OCP system parameters. ocp.health-check.status.available-keyword specifies the available status keyword of the API. ocp.health-check.status.unavailable-keyword specifies the unavailable status of the API.
Examples
Request example
Query the health status of the application and names of unavailable modules if any.
GET /api/status?includeUnavailableComponent=true
Response example
When the application is healthy:
okayWhen the application is unhealthy:
badWhen the application is unhealthy, query the names of the unhealthy modules:
bad monitordb