Blob Object List

GET

objects

Blob Object List

curl --request GET \
  --url https://blob.squarecloud.app/v1/objects \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://blob.squarecloud.app/v1/objects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blob.squarecloud.app/v1/objects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blob.squarecloud.app/v1/objects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://blob.squarecloud.app/v1/objects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "objects": [
      {
        "id": "ID/name1_ltq7b2sw-de6241.jpeg",
        "size": 78266,
        "created_at": "2024-03-13T19:31:28.776Z"
      },
      {
        "id": "ID/name_ltq7b2sw-de6243-ex1.jpeg",
        "size": 90466,
        "created_at": "2024-03-13T19:35:28.776Z",
        "expires_at": "2024-03-14T19:35:28.776Z"
      }
    ],
    "continuationToken": null
  }
}

string

requis

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

Object List énumère les fichiers stockés sous votre compte, optionnellement filtrés par un préfixe de nom, et pagine les grands buckets à l’aide d’un jeton de continuation plutôt que de tout renvoyer d’un coup. Utilisez-le pour construire un explorateur de fichiers, confirmer qu’un upload a bien été effectué, ou réconcilier vos propres enregistrements avec ce que Square Cloud possède réellement. Chaque page est mise en cache par compte, préfixe et jeton pendant 30 minutes, donc les appels répétés avec les mêmes paramètres sont servis depuis le cache plutôt que de solliciter le stockage à nouveau. Les appels au-delà de 10 requêtes par 30 secondes sont bloqués pendant 30 secondes. Les objets envoyés avec une expiration comportent un champ expires_at ; les objets permanents l’omettent. Pour supprimer un objet une fois son ID trouvé, consultez Suppression d’objets ; pour envoyer de nouveaux fichiers, consultez Object Post.

string

Une chaîne représentant le préfixe du fichier.
Doit respecter le motif a to z, A to Z, 0 to 9, and _. (3 à 32 caractères)

string

Une chaîne représentant le jeton de continuation pour la liste des fichiers. (1000 objets par page)

Réponse

string

Indique si l’appel a réussi. “success” en cas de succès, “error” sinon.

object

Afficher Afficher l'objet

array

Afficher Afficher l'objet

string

L’identifiant de l’objet.

integer

La taille de l’objet en octets.

ISO 8601

La date et l’heure de création de l’objet.

ISO 8601

La date et l’heure d’expiration de l’objet.

string

Jeton pour récupérer la page suivante ; renvoyez-le en tant que paramètre de requête continuationToken. null ou absent lorsqu’il n’y a plus d’objets.

{
  "status": "success",
  "response": {
    "objects": [
      {
        "id": "ID/name1_ltq7b2sw-de6241.jpeg",
        "size": 78266,
        "created_at": "2024-03-13T19:31:28.776Z"
      },
      {
        "id": "ID/name_ltq7b2sw-de6243-ex1.jpeg",
        "size": 90466,
        "created_at": "2024-03-13T19:35:28.776Z",
        "expires_at": "2024-03-14T19:35:28.776Z"
      }
    ],
    "continuationToken": null
  }
}

Dépannage

Code de statut 400
Code de statut 401
Code de statut 429

Lié à l’objet

// 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 continuation token is invalid (must be a string up to 2048 characters).
{
    "status": "error",
    "code": "INVALID_CONTINUATION_TOKEN"
}

// The request to list the objects failed. Please try again.
{
    "status": "error",
    "code": "LIST_FAILED"
}

Non autorisé

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

Limite de débit atteinte

// List rate limit reached (10 requests per 30s window, blocked for 30s).
{
    "status": "error",
    "code": "RATE_LIMITED"
}

Object PostCette documentation fournit une vue d'ensemble complète de l'endpoint POST /v1/objects de l'API Blob de SquareCloud.

Blob Object List

curl --request GET \
  --url https://blob.squarecloud.app/v1/objects \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://blob.squarecloud.app/v1/objects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blob.squarecloud.app/v1/objects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blob.squarecloud.app/v1/objects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://blob.squarecloud.app/v1/objects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "objects": [
      {
        "id": "ID/name1_ltq7b2sw-de6241.jpeg",
        "size": 78266,
        "created_at": "2024-03-13T19:31:28.776Z"
      },
      {
        "id": "ID/name_ltq7b2sw-de6243-ex1.jpeg",
        "size": 90466,
        "created_at": "2024-03-13T19:35:28.776Z",
        "expires_at": "2024-03-14T19:35:28.776Z"
      }
    ],
    "continuationToken": null
  }
}

Endpoints Blob

Upload par Morceaux

Réponse

Dépannage

Lié à l’objet

Non autorisé

Limite de débit atteinte

​Réponse

​Dépannage

​Lié à l’objet

​Non autorisé

​Limite de débit atteinte

Réponse

Dépannage

Lié à l’objet

Non autorisé

Limite de débit atteinte