コンテンツにスキップ

環境

DUST は、デプロイされた 3 つのサービスとして動作します。ほとんどの連携では DUST API のみが必要です。AuthD には、API の /api/auth/* パスを介してアクセスします。

サービスURL用途
DICE Web アプリhttps://dice4.dustid.ioDUST ワークフロー用の公式 Web UI。
DUST APIhttps://apid.dustid.ioコア API。Scalar リファレンスは /api/docs にあります。
AuthDhttps://authd.dustid.ioアカウント、組織、セッション、OIDC、サービスアカウント。

DUST API は、以下のルート以下でプラットフォームを公開します。

パス用途
/api/auth/tokenAuthD API キーを bearer トークンと交換します。
/api/auth/jwksDUST API を介して AuthD JWKS を取得します。
/api/v1/*DUST API のコア操作。
/api/openapi.jsonAPI が提供する、生成済みの OpenAPI 仕様。
/api/docsインタラクティブな Scalar リファレンス。

生成されたエンドポイントの完全なカタログについては API リファレンスを、すべての呼び出しに含まれるリクエストコンテキストヘッダーについては規約を参照してください。

DUST API は、標準のヘルスプローブをサーバールート(/api 以下ではありません)で提供します。

パス確認内容障害時の動作
/livezLiveness — プロセスが稼働中であること。サーバーの稼働中は常に 200。
/readyzReadiness — データベースへのラウンドトリップを含みます。データベースの確認に失敗した場合、または 2 秒のタイムアウトを超えた場合は 503。
/healthzReadiness 確認のエイリアス。/readyz と同じ。

正常時には、3 つすべてが { "status": "ok", "timestamp": "…" } を返します。Readiness 確認では、正常でない場合に 503 とともに { "status": "error", … } を返します。稼働時間モニターの監視先には /readyz(または /healthz)を指定してください。