オブジェクトとストレージ

オブジェクトとストレージに関するドキュメント

ベースパス:/api/v1/objects

ファイルダウンロードとストレージ使用量統計のエンドポイントを提供します。ワークフロー実行中に生成されたファイルはオブジェクトストレージ(S3 互換)に保存され、事前署名 URL 経由でダウンロードできます。


エンドポイント概要

メソッドパス認証説明
GET/api/v1/objects/downloadなしオブジェクトキーでファイルをダウンロード
GET/api/v1/objects/storage-usageJWTストレージ使用量統計を取得

GET /api/v1/objects/download

オブジェクトキーを使用してオブジェクトストレージからファイルをダウンロードします。このエンドポイントは 公開 です — 認証は不要です。オブジェクトキーはアクセストークンとして機能します(長く、ランダムで、推測が困難です)。

認証

不要です。

クエリパラメータ

パラメータ必須説明
objectKeystringはいファイルのオブジェクトストレージキー(パス)
typestringいいえダウンロード形式:"attachment"(ダウンロードプロンプト)または "inline"(ブラウザで表示)

動作

サーバーはオブジェクトの事前署名 URL を生成し、ブラウザをそこへリダイレクトするか、ファイルを直接ストリーミングします。type パラメータは Content-Disposition ヘッダーを制御します。

bash

レスポンス

ファイルへリダイレクトするか、直接ストリーミングします。事前署名 URL への 302 リダイレクト。

エラー

ステータス理由
400 Bad RequestobjectKey パラメータが欠落
404 Not Foundストレージにオブジェクトが見つからない

GET /api/v1/objects/storage-usage

アクティブな組織(または特定のユーザー)のストレージ使用量統計を返します。

認証

JWT が必要です(authMiddleware)。

クエリパラメータ

パラメータ必須説明
createdBystring (UUID)いいえ特定ユーザーのアップロードにフィルタ(管理者用)

レスポンス 200 OK

json
フィールド説明
orgKeystring組織キー
totalBytesnumber使用ストレージ合計(バイト)
inputBytesnumber入力ファイルが使用するバイト数
outputBytesnumber出力ファイルが使用するバイト数
fileCountnumber保存ファイルの合計数
breakdownarrayワークフローごとのストレージ使用量内訳

内訳項目のフィールド:

フィールド説明
workflowIdstring (UUID)ワークフロー ID
workflowNamestringワークフロー名
bytesnumberこのワークフローの実行が使用するストレージ
fileCountnumberこのワークフローのファイル数

bash

オブジェクトキー形式

オブジェクトキーは構造化されたパス形式に従います。

text

これらのキーはワークフロー実行出力のダウンロード URL を構築する際に使用されます。

ja/api-docs/objects-and-storage