Blob エンドポイント
Blob オブジェクトの一覧
このドキュメントは、SquareCloud Blob API の GET /v1/objects エンドポイントの包括的な概要を提供します。
GET
/
v1
/
objects
Blob オブジェクトの一覧
curl --request GET \
--url https://blob.squarecloud.app/v1/objects \
--header 'Authorization: <authorization>'import requests
url = "https://blob.squarecloud.app/v1/objects"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://blob.squarecloud.app/v1/objects")
.header("Authorization", "<authorization>")
.asString();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
}
}
オブジェクト一覧は、アカウント配下に保存されているファイルを列挙します。名前のプレフィックスで絞り込むこともでき、すべてを一度に返す代わりに継続トークンを使って大きなバケットをページングします。ファイルブラウザの構築、アップロードが完了したことの確認、Square Cloud側の実データと自分の記録との突き合わせなどに使用できます。
各ページはアカウント・プレフィックス・トークンの組み合わせごとに30分間キャッシュされるため、同じパラメータでの繰り返し呼び出しはストレージに再アクセスせずキャッシュから返されます。30秒間に10リクエストを超えた呼び出しは30秒間ブロックされます。有効期限付きでアップロードされたオブジェクトには
expires_at フィールドが含まれ、永続的なオブジェクトには含まれません。
IDが分かったオブジェクトを削除するにはオブジェクトの削除を、新しいファイルをアップロードするにはオブジェクトのアップロードを参照してください。
string
ファイルのプレフィックスを表す文字列。
a to z, A to Z, 0 to 9, and _ のパターンに従う必要があります。（3〜32 文字）
a to z, A to Z, 0 to 9, and _ のパターンに従う必要があります。（3〜32 文字）
string
ファイル一覧の継続トークンを表す文字列。（1 ページあたり 1000 オブジェクト）
レスポンス
string
呼び出しが成功したかどうかを示します。成功の場合は “success”、そうでない場合は “error” です。
object
{
"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
}
}
トラブルシューティング
- 400 ステータスコード
- 401 ステータスコード
- 429 ステータスコード
オブジェクト関連
// 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"
}
認証エラー
// The API key is missing or invalid. Set a valid key in the Authorization header.
{
"status": "error",
"code": "ACCESS_DENIED"
}
レート制限
// List rate limit reached (10 requests per 30s window, blocked for 30s).
{
"status": "error",
"code": "RATE_LIMITED"
}
⌘I
Blob オブジェクトの一覧
curl --request GET \
--url https://blob.squarecloud.app/v1/objects \
--header 'Authorization: <authorization>'import requests
url = "https://blob.squarecloud.app/v1/objects"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://blob.squarecloud.app/v1/objects")
.header("Authorization", "<authorization>")
.asString();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
}
}