Blob チャンクアップロードの開始

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/chunked?name=dataset&filename=reads.fastq.gz&prefix=genomics&private=true' \
  --header 'Authorization: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'dataset',
  filename: file.name,
  prefix: 'genomics',
  private: 'true',
});

const res = await fetch(`https://blob.squarecloud.app/v1/objects/chunked?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
});
const { response: upload } = await res.json();
// persist upload.upload: it is the handle to this upload

import requests

response = requests.post(
    'https://blob.squarecloud.app/v1/objects/chunked',
    headers={'Authorization': 'YOUR_API_KEY'},
    params={'name': 'dataset', 'filename': 'reads.fastq.gz', 'prefix': 'genomics', 'private': 'true'},
)
upload = response.json()['response']

{
  "status": "success",
  "response": {
    "upload": "Zk3pQ8vR2mWx7LcT0aYbNe5uHs1JqGd9KoVfBr4XtIy6EwUz.q2Ws8nLc0VbR5TfYp3Hk",
    "id": "prv/3155597145698959364/genomics/dataset_mugws5c0-3c59dc048e8850243be8079a5c74d079.fastq.gz",
    "private": true,
    "url": null,
    "name": "dataset",
    "prefix": "genomics",
    "chunk": {
      "min_size": 5242880,
      "max_size": 33554432,
      "max_parts": 2048,
      "max_object_size": 10737418240
    }
  }
}

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

チャンクの開始は、1 回のリクエストの上限である 100 MB を超え、最大 10 GiB までのファイル向けのフローであるチャンクアップロードを開始します。不透明な upload トークンを返すので、以降の呼び出しではこれを使用します。

開始

このルートです。upload トークンを保持してください。

パートを送信する

チャンクの送信で、任意の順序で、同時に最大 6 つまで送信します。

完了

チャンクの完了でファイルを確定します。キャンセルする場合はチャンクの中止を使用します。

サーバー側のセッションはありません: トークンがアップロードの状態のすべてなので、アップロードがページの再読み込みをまたぐ可能性がある場合は保存しておいてください。紛失した場合は、未完了のアップロードが未完了のアップロードをトークン付きで一覧表示し、チャンクの状態がどのパートがすでに届いているかを示します。24 時間操作のないアップロードは自動的に中止されます。

パラメーター

クエリパラメーターはオブジェクトのアップロードと同じで、filename と mime_type が追加されます: ここには multipart の外枠がないため、拡張子はクエリから取得する必要があります。blob:write スコープ、またはアップロードトークンと、有効なプランが必要です。

string

必須

拡張子を除いたファイル名。オブジェクトのアップロードと同じパターンです。

string

拡張子を含む元のファイル名。保存される拡張子はここから取得され、次に mime_type から取得され、どちらもない場合は bin になります。

string

filename に拡張子がない場合にのみ、拡張子の決定に使用されます。

string

オブジェクトのアップロードと同じです。

boolean

オブジェクトのアップロードと同じです。

string

オブジェクトのアップロードと同じです。

boolean

オブジェクトのアップロードと同じです。

boolean

オブジェクトのアップロードと同じです。

string

オブジェクトのアップロードと同じです。

boolean

オブジェクトのアップロードと同じです。

string

オブジェクトのアップロードと同じです。

string

オブジェクトのアップロードと同じです。

制限

ファイルサイズ: 最大 10 GiB (10,737,418,240 バイト)。ルールまたはアップロードトークンでより小さい上限が設定されている場合はそれ以下です。
パートサイズ: 最小 5 MB (5,242,880 バイト)、最大 32 MB (33,554,432 バイト)。最後のパートはこれより小さくてもかまいません。
ファイルあたりのパート数: 最大 2048。
アカウントあたりの未完了のアップロード: 32 件。S3 ゲートウェイ経由で開始されたアップロードも含みます (TOO_MANY_OPEN_UPLOADS、429)。
レート制限: 10 秒間に 5 回の開始。
含まれるストレージをすでに超えているアカウントは、アップロードを開始できません (STORAGE_QUOTA_EXCEEDED)。

制限値はハードコードせず、レスポンスの chunk オブジェクトから読み取ってください。

レスポンス

string

成功した場合は “success”、失敗した場合は “error” です。

object

表示オブジェクトを切り替え

string

不透明なアップロードトークン。フローの以降のすべての呼び出しで送信します。

string

完了後にファイルに付与される id。

boolean

ファイルがプライベートになるかどうか。

string | null

ファイルに付与される公開 URL。プライベートの場合は null。

ISO 8601

ファイルが削除される日時。有効期限がある場合のみ含まれます。

string

リクエストで送信された名前。

string

プレフィックス。送信された場合のみ含まれます。

object

このアップロードの制限: min_size と max_size (パートのバイト数)、max_parts、max_object_size (ファイルのバイト数)。

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/chunked?name=dataset&filename=reads.fastq.gz&prefix=genomics&private=true' \
  --header 'Authorization: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'dataset',
  filename: file.name,
  prefix: 'genomics',
  private: 'true',
});

const res = await fetch(`https://blob.squarecloud.app/v1/objects/chunked?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
});
const { response: upload } = await res.json();
// persist upload.upload: it is the handle to this upload

import requests

response = requests.post(
    'https://blob.squarecloud.app/v1/objects/chunked',
    headers={'Authorization': 'YOUR_API_KEY'},
    params={'name': 'dataset', 'filename': 'reads.fastq.gz', 'prefix': 'genomics', 'private': 'true'},
)
upload = response.json()['response']

{
  "status": "success",
  "response": {
    "upload": "Zk3pQ8vR2mWx7LcT0aYbNe5uHs1JqGd9KoVfBr4XtIy6EwUz.q2Ws8nLc0VbR5TfYp3Hk",
    "id": "prv/3155597145698959364/genomics/dataset_mugws5c0-3c59dc048e8850243be8079a5c74d079.fastq.gz",
    "private": true,
    "url": null,
    "name": "dataset",
    "prefix": "genomics",
    "chunk": {
      "min_size": 5242880,
      "max_size": 33554432,
      "max_parts": 2048,
      "max_object_size": 10737418240
    }
  }
}

エラー

コード	HTTP	発生する状況
`INVALID_OBJECT_*` / `INVALID_STORAGE_AUTO_DOWNLOAD`	400	オブジェクトのアップロードと同様に、パラメーターが無効。
`INVALID_FILE_TYPE` / `BLOCKED_FILE_TYPE` / `FILE_TYPE_NOT_ALLOWED`	400	拡張子の形式が正しくない、ブロックされている、またはルールやトークンで許可されていない。
`PERMISSION_DENIED`	401	アカウントに有効なプランがない。
`UPLOAD_TOKEN_USED`	401	アップロードトークンの使用回数が残っていない。期限切れのトークンは `ACCESS_DENIED` を返します。
`STORAGE_QUOTA_EXCEEDED`	403	アカウントがすでに含まれるストレージを超えている。
`PREFIX_NOT_ALLOWED`	403	アップロードトークンが別のプレフィックスに紐付けられている。
`UPGRADE_REQUIRED`	403	オプションに上位のプランが必要。
`TOO_MANY_OPEN_UPLOADS`	429	アカウントに 32 件の未完了のアップロードがある。いずれかを完了または中止してください。
`RATE_LIMITED`	429	10 秒間に 5 回を超えて開始した。
`UPLOAD_FAILED`	500	アップロードを開始できなかった。再試行してください。
`PRIVATE_STORAGE_UNAVAILABLE` / `PUBLIC_STORAGE_UNAVAILABLE`	503	ストレージが一時的に利用できない。再試行してください。

はじめに

オブジェクト

チャンクアップロード

アカウント

共有リンク

S3

Blob チャンクアップロードの開始

パラメーター

制限

レスポンス

エラー

関連項目

​パラメーター

​制限

​レスポンス

​エラー

​関連項目

パラメーター

制限

レスポンス

エラー

関連項目