📦aidp-volumes
- ソース
- GitHub で見る ↗
説明
AIDP ボリュームを操作します — ボリュームの一覧表示、ボリューム内のファイル閲覧、PAR フローを介したアップロード/ダウンロード、およびディレクトリの作成を行います。 次のような場合に使用: ユーザーがボリュームについて言及している場合、大容量ファイルやバイナリファイルをステージングする必要がある場合、またはボリュームとの間でデータを移動する場合(ワークスペースのファイルシステムとは別のものです)。 コントロールプレーンの操作には公式の `aidp` CLI を使用します。
原文を表示
Work with AIDP volumes — list volumes, browse files inside a volume, upload/download via the PAR flow, and create directories. Use when the user mentions volumes, needs to stage large/binary files, or move data in/out of a volume (distinct from the workspace filesystem). Control-plane via the official `aidp` CLI.
ユースケース
- ✓ボリュームについて言及されている
- ✓大容量ファイルやバイナリファイルをステージングする
- ✓ボリュームとの間でデータを移動する
本文(日本語訳)
aidp-volumes — ボリュームファイル & PAR転送
AIDPのボリュームとそのコンテンツを管理します。
ボリュームはワークスペースのファイルシステムとは別に設けられた、大容量・バイナリデータ向けのステージングエリアです。
主要エンジン: 公式Oracle aidp CLI の volume グループ(同一のREST API + 認証)。
CLIがインストールされていない場合のフォールバックとして oci raw-request を使用します。
次のような場合に使用
- 「ボリューム一覧の表示」「ボリュームXの内容確認」「ボリュームへのファイルのアップロード/ダウンロード」「ボリューム内へのディレクトリ作成」
- 大容量ファイルまたはバイナリファイルのステージング
CLI(推奨)
references/aidp-cli-map.md に基づく利用可能コマンド:
volume list | get | create | list-files | make-dir | upload-file[-with-par] | download-file[-with-par] | delete-file | delete-dir
すべてのコマンドに共通オプション:
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region <r>
# 動作確認済み: list には catalogKey と schemaKey の両方が必要
aidp volume list --catalog-key <cat> --schema-key <cat.schema> \
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1
aidp volume get <key> --instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # 単一ボリューム取得
aidp volume list-files <key> --instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # ファイル一覧表示
aidp volume upload-file-with-par|download-file-with-par <key> ... # PAR転送(バイナリ安全)
aidp volume make-dir|delete-file|delete-dir <key> ...
変更を伴う操作(create / make-dir / upload-file[-with-par] / delete-file / delete-dir):
実行前にリクエストボディを .aidp/payloads/ に保存し、ユーザーに確認を求めてください
(references/payloads.md 参照)。
フォールバック(CLIなし) — oci raw-request を使用して同一のREST + 認証で
…/20240831/dataLakes/<DATALAKE_OCID>/… に対してアクセスします
(認証の優先順位は references/oci-raw-request.md 参照):
GET /volumes?catalogKey=<cat>&schemaKey=<cat.schema>(両パラメータ必須。省略または片方のみだと 400 InvalidParameter が返り、エラーメッセージに欠落しているキー名が示される)GET /volumes/<key>GET /volumes/<key>/files(ファイル一覧)- PAR アップロード/ダウンロード:
POST /volumes/<key>/actions/…後、返却されたPAR URLに対してPUT/GETでバイト転送 POST /volumes/<key>/actions/makeDir
確認優先・情報捏造禁止: このvolumesルートは未検証です。
GET /volumes?catalogKey=…単体では 400 が返りました(schemaKeyも必要)。 書き込みやアップロードを行う前に、必ず実際のGET/volume listで正確なパラメータを確認し、 動作確認済みの内容をreferences/rest-endpoint-map.mdに記録してください。2026-06-10 de-agent にて実環境確認済み — 修正情報: ルートは存在します(削除されていません)。
GET …/volumesをパラメータなしで実行すると 400 InvalidParameter が返り、 両方の欠落キーが明示されます: 「query param schemaKey must not be null; query param catalogKey must not be null」 — つまり、ボリューム一覧の取得にはcatalogKeyとschemaKeyの両方のクエリパラメータが必須です。
ワークフロー
- 確認:
aidp volume list --catalog-key <cat> --schema-key <cat.schema>を実行 (エラーが出た場合は 400 レスポンスから必須パラメータの形式を確認) - 参照: ボリューム一覧 →
list-files <key>でファイル確認、get <key>で単一ボリュームの詳細取得 - アップロード:
upload-file-with-par/ ダウンロード:download-file-with-par(PARによるバイト転送はObject Storageと直接行われ、JSON APIを経由しない) - ディレクトリ作成:
make-dir - 削除・上書きを伴う操作の前には必ずユーザー確認を行う
ボリュームオブジェクトのライフサイクル(ファイルではなくボリューム自体)
ファイル操作に加え、ボリュームオブジェクト自体にも固有のCRUDがあります:
aidp volume create | update | delete(REST:POST /volumes·PUT /volumes/<key>·DELETE /volumes/<key>)- ディレクトリ操作:
make-dir | update-dir | delete-dir
createのリクエストボディには displayName、catalogKey、schemaKey(およびtype/location)が含まれます。
書き込み前に aidp help volume create や実際のリードで正確なフィールドを必ず確認してください
(list 同様、実在するcatalog/schemaキーが必要です)。
ボリュームのアクセス権付与については aidp-roles-access(volumeの行)を参照。
create/update/deleteのリクエストボディは .aidp/payloads/ に保存し、事前にユーザー確認を行ってください。
注意事項
- PAR転送はバイト精度を保証 — バイナリファイル(wheels / jar / parquet)もテキストも正確に転送できます。
- 非同期(202): PARのプロビジョニングやディレクトリ操作では、
202とともに操作キーが返る場合があります。 終了状態になるまでasync-opsエンドポイントをポーリングしてください (aidp-observability/oci-raw-request.md参照)。 - 大容量ステージングファイルは
aidp-ingest-file-to-tableの前処理としてボリュームに置くのが適切です。 - ワークスペース / カタログにスコープされています — 一覧取得前にワークスペースとカタログを確認してください。
参照
- references/aidp-cli-map.md
- references/payloads.md
- references/oci-raw-request.md
- references/no-mcp-rest-map.md
- references/rest-endpoint-map.md
- 連携スキル:
aidp-ingest-file-to-table、aidp-workspace-files
原文(English)を表示
aidp-volumes — volume files & PAR transfers
Manage AIDP volumes and their contents — the staging area for larger/binary data, distinct from the
workspace filesystem. Primary engine: the official Oracle aidp CLI volume group (same REST API +
auth); oci raw-request is the fallback when the CLI isn't installed.
When to use
- "List volumes / what's in volume X", "upload/download a file to/from a volume", "make a directory in a volume", staging large or binary files.
CLI (preferred)
Per references/aidp-cli-map.md: volume list | get | create | list-files | make-dir | upload-file[-with-par] | download-file[-with-par] | delete-file | delete-dir. All take
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region <r>.
# LIVE-VERIFIED: list needs BOTH catalogKey AND schemaKey
aidp volume list --catalog-key <cat> --schema-key <cat.schema> \
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1
aidp volume get <key> --instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # one volume
aidp volume list-files <key> --instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # browse files
aidp volume upload-file-with-par|download-file-with-par <key> ... # PAR transfer (binary-safe)
aidp volume make-dir|delete-file|delete-dir <key> ...
Mutating ops (create/make-dir/upload-file[-with-par]/delete-file/delete-dir): persist the body
to .aidp/payloads/ and confirm with the user before running (see references/payloads.md).
Fallback (no CLI) — same REST + auth via oci raw-request against
…/20240831/dataLakes/<DATALAKE_OCID>/… (auth ladder in references/oci-raw-request.md):
GET /volumes?catalogKey=<cat>&schemaKey=<cat.schema> (both params required; a bare path / single param
returns 400 InvalidParameter — the error names the missing key) · GET /volumes/<key> · files under
GET /volumes/<key>/files · PAR upload/download via POST /volumes/<key>/actions/… then PUT/GET the
bytes to the returned PAR URL · POST /volumes/<key>/actions/makeDir.
Verify-first (no-fabrication): the volumes routes are UNVERIFIED here —
GET /volumes?catalogKey=…alone returned 400 (also needsschemaKey). Confirm the exact params with a liveGET/volume listbefore any write/upload; record the working shape inreferences/rest-endpoint-map.md.Live-verified 2026-06-10 on de-agent — correction: the route EXISTS (not removed). A bare
GET …/volumesreturns 400 InvalidParameter naming both missing keys — "query param schemaKey must not be null; query param catalogKey must not be null" — so listing volumes requires bothcatalogKeyandschemaKeyquery params.
Workflow
- Verify:
aidp volume list --catalog-key <cat> --schema-key <cat.schema>(read back the required-param shape from the 400 if it errors). - Browse: list volumes →
list-files <key>;get <key>for one volume's details. - Upload:
upload-file-with-par; download:download-file-with-par(PAR bytes move directly to/from Object Storage, not through the JSON API). - Dirs:
make-dir. - Confirm before destructive/overwrite operations.
Volume-object lifecycle (the volume itself, not its files)
Beyond file ops, the volume object has its own CRUD: aidp volume create | update | delete
(REST POST /volumes · PUT /volumes/<key> · DELETE /volumes/<key>), plus directory ops
make-dir | update-dir | delete-dir. Create body carries displayName, catalogKey, schemaKey (+
type/location) — confirm the exact fields with aidp help volume create / a live read before writing
(routes need real catalog/schema keys, like list). Grants on a volume → aidp-roles-access (volume row).
Persist create/update/delete bodies to .aidp/payloads/ and confirm first.
Notes
- PAR transfers are byte-accurate — they carry binary fine (wheels/jars/parquet) as well as text.
- Async (202): PAR-provisioning or dir actions may return
202with an operation key — poll the async-ops endpoint until terminal (seeaidp-observability/oci-raw-request.md). - Volumes are the right home for big staging files before
aidp-ingest-file-to-table. - Workspace/catalog-scoped — confirm the workspace and catalog before listing.
References
- references/aidp-cli-map.md · references/payloads.md · references/oci-raw-request.md · references/no-mcp-rest-map.md · references/rest-endpoint-map.md · pairs with
aidp-ingest-file-to-table,aidp-workspace-files
原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。