ヘルスチェック — Orbitvu Documentation

監視ツールから呼び出して、プラグインが ORBITVU CLOUD に接続できること、およびジョブが止まったままになっていないことを確認できるシークレット URL です。

Health Check URL は Stores → Configuration → Orbitvu Cloud → Health Check にあります。View health status をクリックするとブラウザーで開きます。また、監視ツール（例：アップタイム監視ツールや Grafana）に追加することもできます。

Health Check の設定

この URL は JSON ドキュメントを返します。

{
  "status": "ok",
  "sdk_connected": true,
  "auto_synch_locked": false,
  "auto_link_locked": false,
  "presentations_count": 42,
  "plugin_version": "2.1.0",
  "timestamp": "2026-10-30T10:30:00+00:00"
}

フィールド	意味
`status`	`ok`。プラグインが ORBITVU CLOUD に接続できない場合は `degraded`。
`sdk_connected`	プラグインがライセンスキーを使用して ORBITVU SUN API に接続できるかどうか。
`auto_synch_locked`, `auto_link_locked`	同期または自動リンクが現在実行中かどうか（ロックが長時間残っている場合は、ジョブが止まっていることを示します）。
`presentations_count`	商品にリンクされているプレゼンテーションの数。
`plugin_version`	インストールされているプラグインのバージョン。
`timestamp`	チェックの日時。

HTTP ステータスコード：200 – ok、503 – degraded、401 – キーがない、またはキーが正しくない。

URL にはシークレットキー（ov_auth）が含まれているため、他者と共有しないでください。監視ツールでは、代わりに HTTP ヘッダー X-Orbitvu-Key でキーを送信することもできます。この方法なら、キーがサーバーのアクセスログに残りません。Generate new url をクリックすると新しいキーが作成されます。作成後は監視ツールの設定を更新してください。