Blob ファイルのコピー・移動・名前変更

POST

objects

copy

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/copy' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": "pub/3155597145698959364/uploads/IMG_2041.png",
    "destination": { "name": "cover", "prefix": "posts/launch" },
    "move": true
  }'

const response = await fetch('https://blob.squarecloud.app/v1/objects/copy', {
  method: 'POST',
  headers: {
    Authorization: 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    source: 'pub/3155597145698959364/uploads/IMG_2041.png',
    destination: { name: 'cover', prefix: 'posts/launch' },
    move: true,
  }),
});

{
  "status": "success",
  "response": {
    "id": "pub/3155597145698959364/posts/launch/cover.png",
    "private": false,
    "url": "https://blob.squarecloud.dev/pub/3155597145698959364/posts/launch/cover.png",
    "size": 416230,
    "source": "pub/3155597145698959364/uploads/IMG_2041.png",
    "moved": true,
    "replaced": false
  }
}

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

オブジェクトのコピーは、ファイルを新しい名前、プレフィックス、または公開範囲で複製します。処理はすべてサーバー上で行われ、アプリケーションを経由するバイトはありません。move: true を指定するとその後コピー元が削除されます。これがファイルの名前変更や移動の方法です。blob:write スコープと有効なプランに加えて、コピー元ファイルへの blob:read が必要です。

コピーはコピー元の拡張子、コンテンツタイプ、キャッシュ、disposition、メタデータを保持します。
コピーはストレージ枠にカウントされますが、移動はカウントされません。

パラメーター

string

必須

コピーするファイルの id。

object

必須

コピー先。

表示プロパティ

string

必須

拡張子を除いた新しい名前。オブジェクトのアップロードと同じパターンです。

string

新しいプレフィックス。省略するとコピーはルートに保存されます。

boolean

コピーの公開範囲。デフォルトはコピー元と同じです。

string | null

現在時刻から数えた新しい有効期限 (30d、6h)。null にすると有効期限が削除されます。省略するとコピー元の有効期限の日時が保持されます。

boolean

デフォルト:"false"

新しい名前にランダムな接尾辞を追加します。プライベートなコピーには常に付与されます。

boolean

デフォルト:"false"

true にすると、コピーが成功した後にコピー元が削除されます。

boolean

デフォルト:"false"

true にすると、コピー先の既存ファイルを置き換えます。それ以外の場合、リクエストは 409 OBJECT_ALREADY_EXISTS を返します。

レート制限

10 秒間に 10 リクエスト (RATE_LIMITED、429)。

レスポンス

string

成功した場合は “success”、失敗した場合は “error” です。

object

表示プロパティ

string

新しいファイルの id。

boolean

新しいファイルがプライベートかどうか。

string | null

新しいファイルの公開 URL。プライベートの場合は null。

ISO 8601

新しいファイルが削除される日時。有効期限がある場合のみ含まれます。

number

ファイルのサイズ (バイト)。

string

コピー元の id。

boolean

コピー元が削除されたかどうか。

boolean

コピー先の既存ファイルが置き換えられたかどうか。

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects/copy' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": "pub/3155597145698959364/uploads/IMG_2041.png",
    "destination": { "name": "cover", "prefix": "posts/launch" },
    "move": true
  }'

const response = await fetch('https://blob.squarecloud.app/v1/objects/copy', {
  method: 'POST',
  headers: {
    Authorization: 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    source: 'pub/3155597145698959364/uploads/IMG_2041.png',
    destination: { name: 'cover', prefix: 'posts/launch' },
    move: true,
  }),
});

{
  "status": "success",
  "response": {
    "id": "pub/3155597145698959364/posts/launch/cover.png",
    "private": false,
    "url": "https://blob.squarecloud.dev/pub/3155597145698959364/posts/launch/cover.png",
    "size": 416230,
    "source": "pub/3155597145698959364/uploads/IMG_2041.png",
    "moved": true,
    "replaced": false
  }
}

エラー

コード	HTTP	発生する状況
`INVALID_OBJECT`	400	`source` がない、形式が正しくない、またはあなたのものではない。
`INVALID_OBJECT_NAME` / `INVALID_OBJECT_PREFIX`	400	コピー先の名前またはプレフィックスがパターンに一致しない。
`INVALID_DESTINATION`	400	`private` または `security_hash` がブール値ではない。
`INVALID_OBJECT_EXPIRE`	400	`expire` が 1 時間〜1825 日の期間ではない。
`INVALID_OBJECT_SECURITY_HASH`	400	プライベートなコピーで `security_hash: false` が指定された。
`SAME_OBJECT`	400	コピー先がコピー元と同じ。
`PERMISSION_DENIED`	401	アカウントに有効なプランがない。
`UPGRADE_REQUIRED`	403	有効期限に上位のプランが必要。
`STORAGE_QUOTA_EXCEEDED`	403	コピーすると含まれるストレージを超える。
`OBJECT_NOT_FOUND`	404	コピー元が存在しない。
`OBJECT_ALREADY_EXISTS`	409	コピー先にファイルが存在し、`overwrite` が `true` ではない。
`RATE_LIMITED`	429	10 秒間に 10 リクエストを超えた。
`COPY_FAILED`	500	コピーに失敗した。再試行してください。
`PRIVATE_STORAGE_UNAVAILABLE` / `PUBLIC_STORAGE_UNAVAILABLE`	503	ストレージが一時的に利用できない。再試行してください。

はじめに

オブジェクト

チャンクアップロード

アカウント

共有リンク

S3

Blob ファイルのコピー・移動・名前変更

パラメーター

レート制限

レスポンス

エラー

関連項目

​パラメーター

​レート制限

​レスポンス

​エラー

​関連項目

パラメーター

レート制限

レスポンス

エラー

関連項目