API를 이용한 정보 조회

Statuspage에서 확인할 수 있는 각 엔진의 장애 및 성능 저하에 관한 정보는, API를 통해서도 조회 가능합니다. 여기에서는 그 개요를 설명합니다.

자세한 내용은 Statuspage의 문서 AmiVoice API Status API를 참조하십시오.

사용 방법

아래 엔드포인트에 접속하면, Statuspage에 게재된 AmiVoice API의 현재 서비스 상태 등을 JSON 형식으로 조회할 수 있습니다. 또한, 이 API를 이용할 때는, API key 등의 인증 정보는 필요하지 않습니다.

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의 값의 의미에 대해서는, 서비스 상태의 종류를 참조하십시오.

사용 방법​

사용 방법