首批通过分布式安全可靠测评，为关键业务系统打造
查询 OCP 应用状态
更新时间：2023-08-10 11:45:58
分享
功能说明
查询 OCP 应用状态。该接口检查 OCP 应用各模块的状态，返回是否全部状态都处于健康状态。
调用说明
接口约束
调用者需要通过 OCP 应用服务鉴权。
请求路径
GET /api/status
请求参数
| 参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
| includeUnavailableComponent | Boolean | 否 | true | 是否查询不可用模块的名称。 * 默认为 false，此时只返回应用的健康状态； * 指定为 true 时，当存在不健康模块时，同时返回模块的名称； |
返回结果
返回结果为简单文本。
API 可用状态关键字, 默认为 okay
API 不可用状态关键字, 默认为 bad 说明
返回的文本可以在 OCP 系统参数里配置，ocp.health-check.status.available-keyword 配置 API 可用状态关键字，ocp.health-check.status.unavailable-keyword 配置API 不可用状态关键字。
示例
请求示例
- 查询应用的健康状态，若存在不可用模块时，可同时查询不可用模块名称。
GET /api/status?includeUnavailableComponent=true
返回示例
- 应用健康时时：
okay
- 应用不健康时：
bad
- 应用不健康，且请求查询模块名称时：
bad monitordb
