# 查询模型健康状态

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

查询模型的汇总健康状态和最近的通道检查结果。

```text
GET https://billing.moi.matrixorigin.cn/api/v1/taas/ai-models/{id}/health
```

## 调用前准备

1. 准备个人访问令牌。创建和管理方法参阅[创建和管理个人访问令牌](../../../../../guides/genesis/api-keys.md#创建和管理个人访问令牌)。
2. 通过[查询模型目录](list-models.md)选择要查询的模型。

查询范围为当前用户有权访问的数据。

## 请求示例

将示例中的 `$MOI_PERSONAL_ACCESS_TOKEN` 和 `$MODEL_ID` 分别替换为个人访问令牌和所选模型的目录 ID。

```bash
curl --get "https://billing.moi.matrixorigin.cn/api/v1/taas/ai-models/$MODEL_ID/health" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"
```

## 路径参数

::::{div} mo-api-parameter-table

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `id` | string | 是 | 所选模型的目录 ID，取自模型目录查询结果中的 `items[].id`。 |

::::

## 成功响应

返回 HTTP `200`，响应包含模型汇总健康状态和通道检查结果。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "overall_status": "healthy",
  "details": [
    {
      "provider_id": "provider_example",
      "provider_native_model_id": "native_example",
      "provider_native_model_name": "example-chat",
      "target_id": "target_example",
      "status": "healthy",
      "latency_ms": 120,
      "checked_at": 1788710400,
      "error_message": ""
    }
  ]
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `overall_status` | string | 模型汇总健康状态。 |
| `details` | array of object | 已有检查结果的通道；无记录时为空。 |
| `details[].provider_id` | string | 通道所属供应商 ID。 |
| `details[].provider_native_model_id` | string | 供应商模型对象 ID。 |
| `details[].provider_native_model_name` | string | 供应商模型名称。 |
| `details[].target_id` | string | 健康检查目标 ID。 |
| `details[].status` | string | 检查状态。 |
| `details[].latency_ms` | integer | 检查耗时，毫秒。 |
| `details[].checked_at` | integer | 检查时间，Unix 秒。 |
| `details[].error_message` | string | 检查错误说明；无错误时为空。 |

字段路径中的 `[]` 表示数组中的每一项。

:::::
::::::
:::::::