ヘルス状態を取得

GET

/v2/_hc

GET /v2/_hc は認証結果に応じて公開の概要または認証済みの詳細を返します。GET /_hc は同じハンドラーと応答形式を使います。CP Auth が有効な場合、詳細のアクセス権限は実際のリクエストパスに対して検証されるため、一方のパスで許可されるトークンが他方で拒否される場合があります。クエリパラメーターはありません。

リクエスト認証

ヘッダー	必須	説明
Authorization	いいえ	任意。oracle スコープの Bearer <token> が CP Auth の検証に成功すると詳細を返します。このヘッダーがなければ概要を返します。CP Auth が無効な場合は、認証情報の有無にかかわらず概要のみを返します。クエリの token では詳細を取得できません。

認証なしの概要応答

トークンなしでは次の三つの状態フィールドのみを返します。認証済みの応答にもこれらは含まれます。

応答フィールド	型	説明
status	string	全体の状態：ok、degraded、unhealthy。
server.status	string	サーバー状態：ok、degraded、unavailable。
worker.status	string	ワーカー状態：starting、ok、degraded、stale、unavailable。

{
  "status": "ok",
  "server": {
    "status": "ok"
  },
  "worker": {
    "status": "ok"
  }
}

認証済みの詳細応答

Bearer トークンの検証後は以下のフィールドも返します。詳細には CP Auth の有効化が必要です。時刻はすべて RFC 3339 UTC 文字列です。型の末尾の ? は任意フィールドを示し、空の配信マップは省略される場合があります。

応答フィールド	型	説明
version	string	サーバーバージョン。
commit	string	ビルドの commit。
server.components	object	コンポーネント名をキーとするヘルス状態。api、websocket、設定済みの market_overview など。
server.components.api.status	string	API 依存先の状態：starting、ok、degraded、unavailable。
server.components.market_overview.status	string	市場概況の更新状態：ok または unavailable。監視対象の場合に返します。
server.components.websocket.status	string	リアルタイム配信状態：starting、ok、stale、unavailable。
server.components.websocket.last_message_at	string?	この API サーバーが最後にリアルタイム市場イベントを受信した時刻。
server.components.websocket.tickers	object?	BTC などの基軸資産シンボルをキーとする集計 ticker の状態。
server.components.websocket.tickers.<symbol>.status	string	銘柄の ticker 状態：starting、ok、idle、stale。
server.components.websocket.tickers.<symbol>.last_message_at	string?	この銘柄の集計 ticker イベントを最後に受信した時刻。
server.components.websocket.klines	object?	基軸資産シンボルをキーとする集計 1m Kline イベントの状態。
server.components.websocket.klines.<symbol>.status	string	銘柄の 1m Kline 配信状態：starting、ok、idle、stale。
server.components.websocket.klines.<symbol>.last_message_at	string?	この銘柄の集計 1m Kline イベントを最後に受信した時刻。
server.components.websocket.source_tickers	object?	exchange:pair:quote をキーとする観測済みの取引所 ticker の状態。
server.components.websocket.source_tickers.<market>.status	string	取引所イベントの受信状態：ok または stale。
server.components.websocket.source_tickers.<market>.symbol	string	BTC などの基軸資産シンボル。
server.components.websocket.source_tickers.<market>.last_message_at	string?	この API サーバーが最後にこの取引所 ticker イベントを受信した時刻。
server.components.websocket.source_tickers.<market>.source_time	string?	取引所の元の気配時刻（WebSocket イベントの T）。
worker.heartbeat_at	string?	ワーカーのハートビート時刻。取得不可の場合は省略。

{
  "status": "ok",
  "version": "dev",
  "commit": "none",
  "server": {
    "status": "ok",
    "components": {
      "api": {
        "status": "ok"
      },
      "market_overview": {
        "status": "ok"
      },
      "websocket": {
        "status": "ok",
        "last_message_at": "2026-10-02T04:00:00Z",
        "tickers": {
          "BTC": {
            "status": "ok",
            "last_message_at": "2026-10-02T04:00:00Z"
          }
        },
        "klines": {
          "BTC": {
            "status": "ok",
            "last_message_at": "2026-10-02T04:00:00Z"
          }
        },
        "source_tickers": {
          "gmo_coin:BTC_JPY:JPY": {
            "status": "ok",
            "symbol": "BTC",
            "last_message_at": "2026-10-02T04:00:00Z",
            "source_time": "2026-10-02T03:59:50Z"
          }
        }
      }
    }
  },
  "worker": {
    "status": "ok",
    "heartbeat_at": "2026-10-02T04:00:00Z"
  }
}

銘柄のマップは BTC などの基軸資産シンボルを使います。<market> は gmo_coin:BTC_JPY:JPY などの exchange:pair:quote キーです。取引所 ticker はイベントのない状態が 30 秒を超えると stale になりますが、この診断状態や古い source_time だけでは全体の状態は悪化しません。繰り返しのハートビートは last_message_at を更新し、source_time は元の気配時刻を保持します。idle は接続済みで取引がない静かな市場を示します。

HTTP ステータスと認証失敗

両方の応答は同じヘルスステータスを使用し、degraded でも 200 を返す場合があります。必須依存先が利用不可または依存チェックが期限切れの場合は 503 です。CP Auth が有効な場合、不正な認証形式や無効なキーは 401、期限切れや失効したキーは 403 になる場合があります。その他の CP Auth エラーは HTTP ステータスとエラーコードを保持し、メッセージから内部情報を除きます。認証失敗はエラーを返し、概要に自動で切り替えません。稼働監視では Authorization を省略すると、CP Auth の可用性やトークン権限に依存せず公開ヘルス状態を取得できます。ヘルススナップショットがない場合は 503 と公開 JSON 形式を返し、server と worker は unavailable になります。応答は Cache-Control: no-store と Vary: Authorization を使用します。

認証

or

bearerAuth

Required when cp_auth.enabled=true. The token must have the oracle scope.

型

HTTP (bearer)

レスポンス

Cached health summary, or detailed health after successful Bearer authentication.

Content-Type

application/json

{

  

"status": "ok",

  

"server": {

  

  

"status": "ok"

  

},

  

"worker": {

  

  

"status": "ok"

  

}

}

GET

/v2/_hc

Playground

認証

bearerAuth(任意)

Bearer

サンプル