Iniciar um upload em partes

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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

O Início de Upload em Partes abre um upload em partes, o fluxo para arquivos acima do limite de 100 MB por requisição, até 10 GiB. Ele retorna um token upload opaco que você carrega pelas próximas chamadas:

Iniciar

Esta rota. Guarde o token upload.

Enviar as partes

Enviar Parte, em qualquer ordem, até 6 ao mesmo tempo.

Concluir

O Concluir Upload finaliza o arquivo. Ou use o Cancelar Upload para cancelar.

Não há sessão no servidor: o token é todo o estado do upload, então guarde-o se o upload puder atravessar um recarregamento de página. Perdeu o token? O Uploads Abertos lista os uploads abertos com os seus tokens, e o Status do Upload informa quais partes já chegaram. Uploads parados por 24 horas são cancelados automaticamente.

Parâmetros

Os parâmetros de query são os mesmos do Envio de Objeto, mais filename e mime_type: aqui não há envelope multipart, então a extensão precisa vir da query. Exige o escopo blob:write, ou um token de upload, e um plano ativo.

string

obrigatório

O nome do arquivo, sem extensão. Mesmo padrão do Envio de Objeto.

string

O nome original do arquivo, com extensão. A extensão armazenada vem dele, depois de mime_type e, por fim, cai para bin.

string

Usado para a extensão apenas quando filename não tem uma.

string

Igual ao do Envio de Objeto.

boolean

Igual ao do Envio de Objeto.

string

Igual ao do Envio de Objeto.

boolean

Igual ao do Envio de Objeto.

boolean

Igual ao do Envio de Objeto.

string

Igual ao do Envio de Objeto.

boolean

Igual ao do Envio de Objeto.

string

Igual ao do Envio de Objeto.

string

Igual ao do Envio de Objeto.

Limites

Tamanho do arquivo: até 10 GiB (10.737.418.240 bytes), ou menos quando uma regra ou um token de upload define um limite menor.
Tamanho da parte: mínimo de 5 MB (5.242.880 bytes), máximo de 32 MB (33.554.432 bytes). A última parte pode ser menor.
Partes por arquivo: até 2048.
Uploads abertos por conta: 32, contando os uploads abertos pelo gateway S3 (TOO_MANY_OPEN_UPLOADS, 429).
Limite de taxa: 5 aberturas a cada 10 segundos.
Uma conta que já passou do armazenamento incluído não pode abrir uploads (STORAGE_QUOTA_EXCEEDED).

Leia os limites do objeto chunk da resposta em vez de fixá-los no código.

Resposta

string

“success” se bem-sucedida, “error” caso contrário.

object

Mostrar Alternar objeto

string

O token de upload opaco. Envie-o em todas as chamadas seguintes do fluxo.

string

O id que o arquivo terá depois de concluído.

boolean

Se o arquivo será privado.

string | null

A URL pública que o arquivo terá, ou null quando privado.

ISO 8601

Quando o arquivo será excluído. Presente apenas quando ele expira.

string

O nome enviado na requisição.

string

O prefixo, quando um foi enviado.

object

Os limites deste upload: min_size e max_size (bytes da parte), max_parts e max_object_size (bytes do arquivo).

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

Erros

Código	HTTP	Quando
`INVALID_OBJECT_*` / `INVALID_STORAGE_AUTO_DOWNLOAD`	400	Um parâmetro é inválido, como no Envio de Objeto.
`INVALID_FILE_TYPE` / `BLOCKED_FILE_TYPE` / `FILE_TYPE_NOT_ALLOWED`	400	A extensão está malformada, bloqueada ou não é permitida pela regra ou pelo token.
`PERMISSION_DENIED`	401	A conta não tem um plano ativo.
`UPLOAD_TOKEN_USED`	401	O token de upload não tem mais usos. Um token expirado responde `ACCESS_DENIED`.
`STORAGE_QUOTA_EXCEEDED`	403	A conta já passou do armazenamento incluído.
`PREFIX_NOT_ALLOWED`	403	O token de upload está vinculado a outro prefixo.
`UPGRADE_REQUIRED`	403	Uma opção exige um plano superior.
`TOO_MANY_OPEN_UPLOADS`	429	A conta tem 32 uploads abertos. Conclua ou cancele um.
`RATE_LIMITED`	429	Mais de 5 aberturas em 10 segundos.
`UPLOAD_FAILED`	500	O upload não pôde ser aberto. Tente novamente.
`PRIVATE_STORAGE_UNAVAILABLE` / `PUBLIC_STORAGE_UNAVAILABLE`	503	O armazenamento está temporariamente indisponível. Tente novamente.

Relacionados

SDK do Blob: blob.put() executa todo o fluxo em partes para arquivos acima 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
    }
  }
}

Primeiros passos

Objetos

Uploads em partes

Conta

Links de compartilhamento

S3

Iniciar um upload em partes

Parâmetros

Limites

Resposta

Erros

Relacionados

​Parâmetros

​Limites

​Resposta

​Erros

​Relacionados

Parâmetros

Limites

Resposta

Erros

Relacionados