跳至主要内容

使用 API 获取信息

在 Statuspage 上可以确认的各引擎的故障和性能下降相关信息,也可以使用 API 来获取。这里对其概要进行说明。

有关详细信息,请参考 Statuspage 的文档AmiVoice API Status API。

使用方法​

访问以下端点,即可以 JSON 格式获取 Statuspage 上刊载的 AmiVoice API 当前运行状况等信息。此外,使用该 API 时,无需 API 密钥等认证信息。

https://status.amivoice.com/api/v2/summary.json

以下是使用 curl 命令的请求示例。这里为了使响应更易于查看,使用了jq命令。

curl https://status.amivoice.com/api/v2/summary.json | jq

在返回的响应的components中,分别记载了各引擎的"接続障害(连接故障)"、"接続遅延(连接延迟)"、WebSocket 接口的"レスポンス遅延(响应延迟)"信息。此外,还可以获取各引擎的 id 等信息。

例如,假设同步 HTTP・WebSocket 接口的"会話_汎用(16k)"引擎的信息如下所述。

{
"id": "vh7cj7kf3fv6",
"name": "同期HTTP・WebSocketインタフェース[会話_汎用(16k)]",
"status": "operational",
"created_at": "2025-04-30T12:05:15.030+09:00",
"updated_at": "2025-10-27T10:43:00.343+09:00",
"position": 4,
"description": null,
"showcase": false,
"start_date": null,
"group_id": null,
"page_id": "z5s0f2662c1w",
"group": true,
"only_show_if_degraded": false,
"components": [
"78xz9y90wm4g",
"mlmgglv3hvm2",
"8xm4dyh31bjz"
]
}

在这种情况下,components 中 id 为"78xz9y90wm4g"、"mlmgglv3hvm2"、"8xm4dyh31bjz"的,即为同步 HTTP・WebSocket 接口的"会話_汎用(16k)"引擎的"接続障害(连接故障)"、"接続遅延(连接延迟)"、WebSocket 接口的"レスポンス遅延(响应延迟)"信息。

此外,引擎信息中记载的 id"vh7cj7kf3fv6",对应于相应 components 的group_id。

例如,同步 HTTP・WebSocket 接口"会話_汎用(16k)"引擎的"接続障害(连接故障)",如下所述。

{
"id": "78xz9y90wm4g",
"name": "接続障害",
"status": "operational",
"created_at": "2025-04-30T12:05:14.603+09:00",
"updated_at": "2025-04-30T12:05:15.038+09:00",
"position": 1,
"description": "APIへの接続における障害状況",
"showcase": true,
"start_date": "2025-04-30",
"group_id": "vh7cj7kf3fv6",
"page_id": "z5s0f2662c1w",
"group": false,
"only_show_if_degraded": false
}

其中当status为"operational"时,表示该 components 当前正常。

关于status值的含义,请参考服务状态的类型。