API を用いた情報取得

Statuspage にて確認できる各エンジンごとの障害やパフォーマンス低下に関する情報は、API を用いて取得することも可能です。ここでは、その概要を説明します。

詳細については、Statuspage のドキュメント AmiVoice API Status API を参照してください。

使い方

以下のエンドポイントにアクセスすると、Statuspage に掲載されている AmiVoice API の現在の稼働状況などを JSON 形式で取得することができます。なお、この 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の値の意味については、サービスの状態の種類についてを参照してください。

使い方​

使い方