Skip to content

その他のAPI

このドキュメントでは、ActiveServerで利用できる他のAPIエンドポイントの概要を説明します。

ヘルスチェック（GET/health/{token}）

サービスのステータスを返すヘルスチェックエントリーポイント。このエンドポイントを使用して、サービスが稼働しているか停止しているか、および現在のシステムパフォーマンスのデータを取得できます。

このエントリーポイントは、アプリケーションプロパティーファイルで次の構成を設定することで有効にできます。ランダムトークン値は、エントリーポイントの{token}を置換するために使用されます。

1
as.settings.health-check-token = <任意のランダムトークン>

重要

ヘルスチェックAPIを使用するには、上記のプロパティファイルにトークンを設定する必要があります。

HTTPステータスコード（200）応答

以下は、有効な構成済みトークンを使用してAPIが呼び出されたときのHTTPステータスコード200のJSONのHTTP応答の例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "status": "OK",
  "dbStatus": "OK",
  "dbProbeElapsed": 10,
  "version": "1.4.1.edesfd",
  "threads": 256,
  "pendingRequests": 0,
  "maxMem": 28900002,
  "currentMem": 1890001,
  "timestamp": "20201101T12:12:30"
}
  • status - ActiveServerステータスは、常にOKを返します。 ActiveServerがサービス停止している場合、応答HTTPステータスコードは200にはなりません。
  • dbStatus - DBステータスは、常にOKを返します。データベースに問題が設定している場合、応答HTTPステータスコードは200にはなりません。
  • dbProbeElapsed - DBのステータスチェックに要した時間。(単位:ミリ秒)
  • version - 現在のActiveServerバージョン。
  • thread - 現在のワーカースレッドの数。
  • pendingRequests - キュー内の保留中の現在のリクエスト数。
  • maxMem - メモリサイズの最大数（単位:バイト）。
  • currentMem - 現在のメモリ使用量（単位:バイト）。
  • timestamp - 現在のUTC時間（形式: yyyy-MM-dd'T'HH:mm:ss）

HTTPステータスコード（403）応答

ヘルスステータストークンが無効な場合、禁止されたHTTPステータスコードを取得する可能性があります。 HTTP応答の本文は次のようになります。

1
2
3
4
{
    "code": "2005",
    "message": "Access is denied."
}

HTTPステータスコード（501）応答

「as.settings.health-check-token」が設定されていない場合、501 Not Implementedが空のHTTP応答Bodyとともに返却されます。