Blob Chunked Upload Init

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/chunked?name=myfile&filename=reads.fastq.gz&expire=30' \
  --header 'Authorization: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'myfile',
  filename: 'reads.fastq.gz',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects/chunked?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
});

const { response: upload } = await response.json();
// persist upload.upload — it is the only handle to this upload

import requests

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

{
  "status": "success",
  "response": {
    "upload": "MzE1NTU5NzE0NTY5ODk1OTM2NC9teWZpbGUtZXgzMC5mYXN0cS5negoyfjQ4WXcuLi4KMzA",
    "id": "3155597145698959364/myfile-ex30.fastq.gz",
    "name": "myfile",
    "prefix": null,
    "url": "https://public-blob.squarecloud.dev/3155597145698959364/myfile-ex30.fastq.gz",
    "chunk": {
      "min_size": 5242880,
      "max_size": 33554432,
      "max_parts": 205,
      "max_object_size": 1073741824
    }
  }
}

string

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Chunked Init öffnet einen Chunked Upload, den Ablauf für Dateien oberhalb der 100-MB-Grenze pro Einzelanfrage, bis zu 1 GiB. Er reserviert den Schlüssel des Objekts und gibt ein opakes upload-Token zurück, das du durch die drei Folgeaufrufe trägst: Chunked Part, um jeden Chunk zu senden, Chunked Complete, um das Objekt abzuschließen, und Chunked Abort, um abzubrechen. Es gibt keine serverseitige Session: Das Token ist der gesamte Upload-Zustand, speichere es also, wenn der Upload einen Seiten-Reload überdauern soll. Ein Client, der sein Token verliert, kann den Upload nicht abbrechen, und die gespeicherten Chunks zählen gegen das Kontolimit von 8 offenen Uploads, bis der Dienst sie zurückfordert (etwa 24 Stunden). Der Query-Vertrag ist derselbe wie bei Object Post, plus filename: Es gibt hier keine Multipart-Hülle, daher muss die gespeicherte Dateiendung aus dem Query-String kommen. Das Hochladen erfordert einen kostenpflichtigen Plan.

string

erforderlich

Eine Zeichenkette, die den Namen der Datei darstellt. (ohne Erweiterung)
Muss dem Muster a bis z, A bis Z, 0 bis 9 und _ entsprechen. (3 bis 32 Zeichen)

string

Der ursprüngliche Dateiname, einschließlich Erweiterung (z. B. reads.fastq.gz). Die gespeicherte Dateiendung wird daraus abgeleitet, mit Fallback auf den mime_type-Parameter, dann auf bin.

string

Eine Zeichenkette, die das Präfix der Datei darstellt.
Muss dem Muster a bis z, A bis Z, 0 bis 9 und _ entsprechen. (3 bis 32 Zeichen)

number

Eine Zahl, die die Ablaufdauer der Datei angibt, im Bereich von 7 bis 1825 Tagen (5 Jahre).

boolean

Auf true setzen, wenn ein Sicherheits-Hash erforderlich ist.

boolean

Auf true setzen, wenn die Datei für automatischen Download vorgesehen werden soll.

Limits

Objektgröße: bis zu 1 GiB (1.073.741.824 Bytes).
Chunk-Größe: mindestens 5 MB, höchstens 32 MB (der letzte Chunk darf kleiner sein).
Chunks pro Objekt: 205 (Teilnummern laufen von 1 bis 205).
Offene Uploads pro Konto: 8 gleichzeitig (TOO_MANY_OPEN_UPLOADS, 429).
Rate Limit: 5 Öffnungen pro 10 Sekunden, darüber hinaus für 10 Sekunden blockiert.

Lies die Limits aus dem chunk-Objekt der Antwort, statt sie fest zu codieren.

Response

string

Gibt an, ob der Aufruf erfolgreich war. “success” bei Erfolg, “error” andernfalls.

object

Anzeigen Objekt ein-/ausblenden

string

Das opake Upload-Token. Trage es durch jeden späteren Aufruf des Ablaufs; es ist das einzige Handle zu diesem Upload.

string

Die ID (der Schlüssel), unter der das Objekt gespeichert wird.

string

Der Name der Datei.

string

Das Präfix, unter dem die Datei gespeichert wird (null, wenn keines gesendet wurde).

string

Die öffentliche CDN-URL, unter der das Objekt nach Abschluss ausgeliefert wird.

object

Die Limits des Chunked-Ablaufs: min_size und max_size (Chunk-Bytes), max_parts und max_object_size (Gesamtbytes).

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/chunked?name=myfile&filename=reads.fastq.gz&expire=30' \
  --header 'Authorization: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'myfile',
  filename: 'reads.fastq.gz',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects/chunked?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
});

const { response: upload } = await response.json();
// persist upload.upload — it is the only handle to this upload

import requests

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

{
  "status": "success",
  "response": {
    "upload": "MzE1NTU5NzE0NTY5ODk1OTM2NC9teWZpbGUtZXgzMC5mYXN0cS5negoyfjQ4WXcuLi4KMzA",
    "id": "3155597145698959364/myfile-ex30.fastq.gz",
    "name": "myfile",
    "prefix": null,
    "url": "https://public-blob.squarecloud.dev/3155597145698959364/myfile-ex30.fastq.gz",
    "chunk": {
      "min_size": 5242880,
      "max_size": 33554432,
      "max_parts": 205,
      "max_object_size": 1073741824
    }
  }
}

Fehlerbehebung

400 Status Code
401 Status Code
403 Status Code
429 Status Code
500 Status Code

Objektbezogen

// The provided object name is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_NAME"
}

// The provided object prefix is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_PREFIX"
}

// The provided expiration value for the object is invalid.
// Must be a number ranging from 7 to 1825. (value in days).
{
    "status": "error",
    "code": "INVALID_OBJECT_EXPIRE"
}

// The file extension is malformed or too long.
{
    "status": "error",
    "code": "INVALID_FILE_TYPE"
}

// Executable/installer extensions (exe, msi, bat, apk, ...) are not accepted.
{
    "status": "error",
    "code": "BLOCKED_FILE_TYPE"
}

Nicht autorisiert

// The API key is missing or invalid. Set a valid key in the Authorization header.
{
    "status": "error",
    "code": "ACCESS_DENIED"
}

// The account has no active paid plan. Uploading to Blob Storage requires a paid plan.
{
    "status": "error",
    "code": "PERMISSION_DENIED"
}

Speicherkontingent überschritten

// You have exceeded your storage quota. Delete some files or upgrade your plan.
{
    "status": "error",
    "code": "STORAGE_QUOTA_EXCEEDED"
}

Rate-limitiert

// Init rate limit reached (5 opens per 10s window, blocked for 10s).
{
    "status": "error",
    "code": "RATE_LIMITED"
}

// 8 chunked uploads already open. Complete or abort one first.
{
    "status": "error",
    "code": "TOO_MANY_OPEN_UPLOADS"
}

Upload fehlgeschlagen

// Failed to open the chunked upload. Please try again later.
{
    "status": "error",
    "code": "UPLOAD_FAILED"
}

Zurück

Chunked PartDiese Dokumentation bietet einen umfassenden Überblick über den Endpoint PUT /v1/objects/chunked der SquareCloud Blob API.

Weiter

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/chunked?name=myfile&filename=reads.fastq.gz&expire=30' \
  --header 'Authorization: YOUR_API_KEY'

const params = new URLSearchParams({
  name: 'myfile',
  filename: 'reads.fastq.gz',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects/chunked?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
});

const { response: upload } = await response.json();
// persist upload.upload — it is the only handle to this upload

import requests

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

{
  "status": "success",
  "response": {
    "upload": "MzE1NTU5NzE0NTY5ODk1OTM2NC9teWZpbGUtZXgzMC5mYXN0cS5negoyfjQ4WXcuLi4KMzA",
    "id": "3155597145698959364/myfile-ex30.fastq.gz",
    "name": "myfile",
    "prefix": null,
    "url": "https://public-blob.squarecloud.dev/3155597145698959364/myfile-ex30.fastq.gz",
    "chunk": {
      "min_size": 5242880,
      "max_size": 33554432,
      "max_parts": 205,
      "max_object_size": 1073741824
    }
  }
}

Blob-Endpunkte

Chunked-Uploads

Blob Chunked Upload Init

Limits

Response

Fehlerbehebung

Objektbezogen

Nicht autorisiert

Speicherkontingent überschritten

Rate-limitiert

Upload fehlgeschlagen

​Limits

​Response

​Fehlerbehebung

​Objektbezogen

​Nicht autorisiert

​Speicherkontingent überschritten

​Rate-limitiert

​Upload fehlgeschlagen

Limits

Response

Fehlerbehebung

Objektbezogen

Nicht autorisiert

Speicherkontingent überschritten

Rate-limitiert

Upload fehlgeschlagen