---
title: "查询 OCP 应用状态 | OceanBase 文档中心"
description: 查询 OCP 应用状态 功能说明 查询 OCP 应用状态。该接口检查 OCP 应用各模块的状态，返回是否全部状态都处于健康状态。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/status 请求参数 参数 类型 必选 示例值 描述 includeUnavailableComp…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# 查询 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 不可用状态关键字。

## **示例**

**请求示例**

- 查询应用的健康状态，若存在不可用模块时，可同时查询不可用模块名称。

```code
GET /api/status?includeUnavailableComponent=true

```

**返回示例**

- 应用健康时时：

```code
okay

```

- 应用不健康时：

```code
bad

```

- 应用不健康，且请求查询模块名称时：

```code
bad monitordb

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线