オブジェクトとストレージ
オブジェクトとストレージに関するドキュメント
ベースパス:/api/v1/objects
ファイルダウンロードとストレージ使用量統計のエンドポイントを提供します。ワークフロー実行中に生成されたファイルはオブジェクトストレージ(S3 互換)に保存され、事前署名 URL 経由でダウンロードできます。
エンドポイント概要
| メソッド | パス | 認証 | 説明 |
|---|---|---|---|
| GET | /api/v1/objects/download | なし | オブジェクトキーでファイルをダウンロード |
| GET | /api/v1/objects/storage-usage | JWT | ストレージ使用量統計を取得 |
GET /api/v1/objects/download
オブジェクトキーを使用してオブジェクトストレージからファイルをダウンロードします。このエンドポイントは 公開 です — 認証は不要です。オブジェクトキーはアクセストークンとして機能します(長く、ランダムで、推測が困難です)。
認証
不要です。
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
objectKey | string | はい | ファイルのオブジェクトストレージキー(パス) |
type | string | いいえ | ダウンロード形式:"attachment"(ダウンロードプロンプト)または "inline"(ブラウザで表示) |
動作
サーバーはオブジェクトの事前署名 URL を生成し、ブラウザをそこへリダイレクトするか、ファイルを直接ストリーミングします。type パラメータは Content-Disposition ヘッダーを制御します。
例
bash
レスポンス
ファイルへリダイレクトするか、直接ストリーミングします。事前署名 URL への 302 リダイレクト。
エラー
| ステータス | 理由 |
|---|---|
400 Bad Request | objectKey パラメータが欠落 |
404 Not Found | ストレージにオブジェクトが見つからない |
GET /api/v1/objects/storage-usage
アクティブな組織(または特定のユーザー)のストレージ使用量統計を返します。
認証
JWT が必要です(authMiddleware)。
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
createdBy | string (UUID) | いいえ | 特定ユーザーのアップロードにフィルタ(管理者用) |
レスポンス 200 OK
json
| フィールド | 型 | 説明 |
|---|---|---|
orgKey | string | 組織キー |
totalBytes | number | 使用ストレージ合計(バイト) |
inputBytes | number | 入力ファイルが使用するバイト数 |
outputBytes | number | 出力ファイルが使用するバイト数 |
fileCount | number | 保存ファイルの合計数 |
breakdown | array | ワークフローごとのストレージ使用量内訳 |
内訳項目のフィールド:
| フィールド | 型 | 説明 |
|---|---|---|
workflowId | string (UUID) | ワークフロー ID |
workflowName | string | ワークフロー名 |
bytes | number | このワークフローの実行が使用するストレージ |
fileCount | number | このワークフローのファイル数 |
例
bash
オブジェクトキー形式
オブジェクトキーは構造化されたパス形式に従います。
text
これらのキーはワークフロー実行出力のダウンロード URL を構築する際に使用されます。
ja/api-docs/objects-and-storage