Files APIとは何か？
Files APIは、URIを参照することで、ファイルを読み取り、書き込み、一覧表示、削除できる標準のHTTP APIです。このAPIを使用すると、ファイルのコンテンツを生バイトとして扱うことが簡単になり、より効率的になります。
APIはUnity Catalog ボリュームをサポートしており、操作するファイルとディレクトリをそのボリュームURIパスを使って指定し、その形式は/Volumes/<catalog_name>/<schema_name>/<volume_name>/<path_to_file>に従います。パスは常に絶対パスです。
Files APIには、ファイル (/fs/files) とディレクトリ (/fs/directories) を操作するための2つの異なるEndpointがあります。両方のEndpointは、標準のHTTPメソッド GET、HEAD、PUT、DELETE、および POST を使用して、そのURIパスで指定されたファイルとディレクトリを管理します。操作とそのパラメータの詳細については、 Files API 3.0リファレンスを参照してください。
Files APIを使用すると、Databricksのデータ転送料金が発生する場合があります。
機能
Files APIでは、次のことができます。
- 単一の要求で最大 5000 MiB のファイルを upload するか、 multipart uploadでより大きなファイルを部分的に upload します。
- 単一のリクエストでファイル全体をdownloadするか、
Rangeヘッダーでファイルの一部をdownloadします。範囲リクエストによる大きなファイルのdownloadを参照してください。 - 条件付きリクエストを使用して、ファイルの現在の
ETagまたはLast-Modified時間に基づいて読み取り、書き込み、または削除を行います。
要件
- ワークスペースのリージョンホスト名にリクエストを送信します。リージョンホスト名でFiles APIを使用するを参照してください。
- Databricksおよびストレージへのネットワーク接続。Files APIのネットワーク接続を参照してください。
バージョン
Files APIには2つのバージョンがあります。これら間の変更点の詳細については、 Files APIのバージョンを参照してください。