Docs/リファレンス/ヘルスチェック/詳細ヘルスチェック
GET/v1/health/deepプラン · Free

詳細ヘルスチェック

詳細ヘルスチェック。DB接続を含む正常性を検証します。

リクエストヘッダー · 1

認証ヘッダー。

Authorizationstring必須

本番用のAPIキー。次の形式で渡します: Bearer ax_live_…

返り値 · 200

標準の { data, meta } エンベロープ。 data は DeepHealthCheckOut 型です。

エンベロープ

dataDeepHealthCheckOut

単一の結果オブジェクト。

metaMeta

ページネーションとリクエストメタデータ。request_iddata_as_ofontology_version を含みます。

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

DeepHealthCheckOut

statusstring

サービスの全体状態。'ok'または'degraded'。

checksobject

各サブシステムの状態(例: {'database': 'ok', 'cache': 'ok'})。

エラー

標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。

すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。