Démarrer un envoi chunked

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Chunked Init ouvre un envoi chunked, le flux destiné aux fichiers dépassant la limite de 100 Mo par requête unique, jusqu’à 10 GiB. Il renvoie un jeton upload opaque que vous transmettez lors des appels suivants :

Init

Cette route. Conservez le jeton upload.

Envoyer les parties

Chunked Part, dans n’importe quel ordre, jusqu’à 6 à la fois.

Finaliser

Chunked Complete scelle le fichier. Ou Chunked Abort pour annuler.

Il n’y a pas de session côté serveur : le jeton constitue tout l’état de l’envoi, conservez-le donc si l’envoi risque de s’étendre au-delà d’un rechargement de page. Vous l’avez perdu ? Envois ouverts liste les envois ouverts avec leurs jetons, et Chunked Status indique quelles parties sont déjà arrivées. Les envois inactifs pendant 24 heures sont annulés automatiquement.

Paramètres

Les paramètres de requête sont les mêmes que dans Object Post, plus filename et mime_type : il n’y a pas d’enveloppe multipart ici, l’extension doit donc provenir de la query. Nécessite le scope blob:write, ou un jeton d’envoi, ainsi qu’un plan actif.

string

requis

Le nom du fichier, sans extension. Même motif que dans Object Post.

string

Le nom de fichier d’origine, extension comprise. L’extension stockée en provient, puis de mime_type, et à défaut elle vaut bin.

string

Utilisé pour l’extension uniquement lorsque filename n’en a pas.

string

Identique à Object Post.

boolean

Identique à Object Post.

string

Identique à Object Post.

boolean

Identique à Object Post.

boolean

Identique à Object Post.

string

Identique à Object Post.

boolean

Identique à Object Post.

string

Identique à Object Post.

string

Identique à Object Post.

Limites

Taille du fichier : jusqu’à 10 GiB (10 737 418 240 octets), ou moins lorsqu’une règle ou un jeton d’envoi fixe une limite inférieure.
Taille d’une partie : 5 Mo minimum (5 242 880 octets), 32 Mo maximum (33 554 432 octets). La dernière partie peut être plus petite.
Parties par fichier : jusqu’à 2048.
Envois ouverts par compte : 32, en comptant les envois ouverts via la passerelle S3 (TOO_MANY_OPEN_UPLOADS, 429).
Limite de débit : 5 ouvertures par 10 secondes.
Un compte qui dépasse déjà son stockage inclus ne peut pas ouvrir d’envois (STORAGE_QUOTA_EXCEEDED).

Lisez les limites dans l’objet chunk de la réponse plutôt que de les coder en dur.

Réponse

string

“success” en cas de succès, “error” sinon.

object

Afficher Afficher l'objet

string

Le jeton d’envoi opaque. Envoyez-le à chaque appel ultérieur du flux.

string

L’id qu’aura le fichier une fois finalisé.

boolean

Indique si le fichier sera privé.

string | null

L’URL publique qu’aura le fichier, ou null s’il est privé.

ISO 8601

Date à laquelle le fichier sera supprimé. Présent uniquement lorsqu’il expire.

string

Le nom envoyé dans la requête.

string

Le préfixe, lorsqu’il a été envoyé.

object

Les limites de cet envoi : min_size et max_size (octets par partie), max_parts, et max_object_size (octets du fichier).

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
    }
  }
}

Erreurs

Code	HTTP	Quand
`INVALID_OBJECT_*` / `INVALID_STORAGE_AUTO_DOWNLOAD`	400	Un paramètre est invalide, comme dans Object Post.
`INVALID_FILE_TYPE` / `BLOCKED_FILE_TYPE` / `FILE_TYPE_NOT_ALLOWED`	400	L’extension est mal formée, bloquée, ou non autorisée par la règle ou le jeton.
`PERMISSION_DENIED`	401	Le compte n’a pas de plan actif.
`UPLOAD_TOKEN_USED`	401	Le jeton d’envoi n’a plus d’utilisations disponibles. Un jeton expiré répond `ACCESS_DENIED`.
`STORAGE_QUOTA_EXCEEDED`	403	Le compte dépasse déjà son stockage inclus.
`PREFIX_NOT_ALLOWED`	403	Le jeton d’envoi est lié à un autre préfixe.
`UPGRADE_REQUIRED`	403	Une option nécessite un plan supérieur.
`TOO_MANY_OPEN_UPLOADS`	429	Le compte a 32 envois ouverts. Terminez-en ou annulez-en un.
`RATE_LIMITED`	429	Plus de 5 ouvertures en 10 secondes.
`UPLOAD_FAILED`	500	L’envoi n’a pas pu être ouvert. Réessayez.
`PRIVATE_STORAGE_UNAVAILABLE` / `PUBLIC_STORAGE_UNAVAILABLE`	503	Le stockage est temporairement indisponible. Réessayez.

Voir aussi

SDK Blob : blob.put() exécute tout le flux d’envoi chunked pour les fichiers de plus de 90 MiB

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
    }
  }
}

Premiers pas

Objets

Uploads par morceaux

Compte

Liens de partage

S3

Démarrer un envoi chunked

Paramètres

Limites

Réponse

Erreurs

Voir aussi

​Paramètres

​Limites

​Réponse

​Erreurs

​Voir aussi

Paramètres

Limites

Réponse

Erreurs

Voir aussi