tus アップロードを作成する
検証済みの Assembly メタデータから、再開可能なアップロードリソースを作成します。
{TUS_URL}検証済みの Assembly レスポンスに含まれる tus_url ケイパビリティ URL をリクエスト先として使用します。API2 ホストに関連付けられ、暗黙的に利用可能な認証情報は使用しません。
通常の固定サイズのアップロードでは、まず num_expected_upload_files をファイル数に設定して
Assembly を作成します。返された assembly_ssl_url と tus_url を以下の例にコピーしてください。返された tus_url を汎用の API ホスト名で置き換えないでください。
この例では 4 バイトを予約してから、テキスト file をアップロードします。実際のファイルでは、そのファイルのバイト長を使用し、PATCH リクエストでそのバイト列を送信してください。
assembly_ssl_url='<assembly_ssl_url from the creation response>'
tus_url='<tus_url from the creation response>'
assembly_metadata=$(printf %s "$assembly_ssl_url" | base64 | tr -d "\n")
curl --fail-with-body -sS --include --request POST \
--url "$tus_url" \
--header 'tus-resumable: 1.0.0' \
--header 'upload-length: 4' \
--header "upload-metadata: assembly_url $assembly_metadata,filename ZmlsZS50eHQ=,fieldname ZmlsZQ=="
成功した 201 レスポンスでは、location ヘッダーにアップロード URL が返されます。その URL を以下にコピーしてください。転送が中断された場合に、サーバーが報告するオフセットから再開できるよう、その URL を保持してください。
upload_url='<Location response header>'
curl --fail-with-body -sS --request PATCH \
--url "$upload_url" \
--header 'tus-resumable: 1.0.0' \
--header 'upload-offset: 0' \
--header 'content-type: application/offset+octet-stream' \
--data-binary 'file'
復旧と完了については、再開可能なアップロードガイドを参照してください。長さの後指定、連結、正確なヘッダー構文については、以下で説明します。
並列アップロードでは、部分リソースを作成し、そのバイト列をアップロードしてから、それらを連結する最終リソースを作成します。最終ファイルだけが Assembly の入力となり、Template によって処理されます。num_expected_upload_files は、部分リソースの数ではなく、最終ファイルの数に設定してください。すべての部分リソースおよび最終リソースの作成リクエストに、assembly_url、filename、fieldname のメタデータを含めてください。tus-js-client で parallelUploads を使用する場合は、これらのフィールドを
metadataForPartialUploads にも指定してください。
通常のアップロードでは、Upload-Concat を含めないでください。各部分リソースの作成リクエストでは、これを partial に設定してください。すべての部分アップロードが完了したら、次の指定で最終リソースを作成します。
Upload-Concat: final;<PARTIAL_UPLOAD_URL_1> <PARTIAL_UPLOAD_URL_2>
プレースホルダーを、部分アップロードで返された完全な Location URL に置き換えてください。final の直後のセミコロンは残し、URL はスペースで区切ってください。URL の順序によって、最終ファイル内のバイトの順序が決まります。
認証
同じ検証済みの Assembly レスポンスに含まれる assembly_ssl_url の Base64 エンコード済みの値を指定して、assembly_url を Upload-Metadata ヘッダーで送信してください。
リクエストヘッダー
完全な JSON スキーマ
固定長、長さ指定延期、部分、または最終の tus アップロードの作成に使用する、小文字に正規化されたヘッダー。
| フィールド | 型と説明 |
|---|---|
tus-resumable必須 | string (常に: "1.0.0")ネゴシエーションで合意された tus のバージョン。 |
upload-metadata必須 | string標準 Base64 の値を任意で付けられる、カンマ区切りの ASCII メタデータキー。成功した Transloadit アップロードには filename と fieldname が含まれます。認証メタデータはトランスポートによって組み立てられます。 検証パターン(正規表現)^[\x21-\x2b\x2d-\x7e]+(?: (?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?)?(?:,[\x21-\x2b\x2d-\x7e]+(?: (?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?)?)*$ |
次のいずれかのスキーマが適用される場合があります:
必須プロパティ: upload-length
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
content-type | string (常に: "application/offset+octet-stream") |
upload-concat | string (常に: "partial") |
upload-defer-length | なしこの値は禁止されています。 |
upload-length必須 | string符号付き 64 ビット整数の範囲内にある、ゼロ埋めやプラス記号を含まない正規形式の符号なし 10 進数で表されるバイト数。 検証パターン(正規表現)^(?:0|[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6]|9223372036854775807)$ |
upload-defer-length: "1"
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
content-type | string (常に: "application/offset+octet-stream") |
upload-concat | string (常に: "partial") |
upload-defer-length必須 | string (常に: "1") |
upload-length | なしこの値は禁止されています。 |
必須プロパティ: upload-concat
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
content-type | なしこの値は禁止されています。 |
upload-concat必須 | string (最大長: 8192)検証パターン(正規表現)^final;(?:https?:\/\/[^/\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]+)?\/resumable\/files\/[^/\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]+(?:\/[^/\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]+)*(?: (?:https?:\/\/[^/\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]+)?\/resumable\/files\/[^/\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]+(?:\/[^/\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]+)*)*$ |
upload-defer-length | なしこの値は禁止されています。 |
upload-length | なしこの値は禁止されています。 |
リクエストボディ
バイナリ形式のリクエストボディ。 application/offset+octet-stream ボディは省略可能です。
レスポンス
HTTP 201
レスポンスボディはありません。
レスポンスヘッダー
完全な JSON スキーマ
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
location必須 | string (最小長: 1)新しいアップロードリソースの URL です。クライアントは、返されたケイパビリティとしてこの URL を検証する必要があります。 |
tus-resumable必須 | string (常に: "1.0.0") |
upload-offset | string符号付き 64 ビット整数の範囲内にある、ゼロ埋めやプラス記号を含まない正規形式の符号なし 10 進数で表されるバイト数。 検証パターン(正規表現)^(?:0|[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6]|9223372036854775807)$ |
x-content-type-options必須 | string (常に: "nosniff") |
エラーレスポンス
テキスト形式のレスポンスボディ。 text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
string次のいずれかのスキーマが適用される場合があります:
バリアント 1: string
string検証パターン(正規表現)
^ERR_[A-Z0-9_]+: [^\r\n]*\n$バリアント 2: string
stringペイロードをそのまま含む、生の text/plain フックエラー形式。JSON のような構造ですが、必ずしも有効な JSON とは限りません。
検証パターン(正規表現)
^\{"error":"(?:[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]|[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff])*"\}$レスポンスヘッダー
完全な JSON スキーマ
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
content-type必須 | string (常に: "text/plain; charset=utf-8") |
tus-resumable必須 | string (常に: "1.0.0") |
x-content-type-options必須 | string (常に: "nosniff") |