Skip to main content
Blob Storage 在 Authorization 请求头中接受两种凭证:
  • API key:在你的账户设置中创建。它适用于所有路由,受你赋予它的 scope 限制。
  • 上传令牌(squp_...):由你的服务器通过上传令牌签发的短期令牌。它只能上传,因此可以安全地交给浏览器。
API 的使用需遵守服务条款和可接受使用政策。
Blob SDK(@squarecloud/blob)会为你发送凭据,并封装了本参考中的每一个路由。

Scope

API key 携带 scope。Blob Storage 读取其中两个: 缺少路由所需 scope 的 key 会收到 403 MISSING_SCOPE。限定于特定应用的 key 无权访问 Blob Storage,会收到 403 RESOURCE_NOT_ALLOWED。
为每个集成分配单独的 key,只赋予它所需的 scope。只负责分发文件的后端需要 blob:read;只负责上传的任务需要 blob:write。

上传令牌

上传令牌只在对象上传和分块上传路由上被接受。其他任何路由都会返回 403 UPLOAD_TOKEN_NOT_ALLOWED。令牌会锁定签发时选定的名称、前缀、可见性、大小和文件类型,并在过期、使用次数用尽或签发它的 API key 被撤销时失效。

S3 网关

S3 工具不会直接发送 API key。它们使用由 API key 派生的访问密钥对对请求进行签名(SigV4):请从 S3 凭证获取该密钥对,并阅读 S3 兼容性。

错误

错误响应遵循 { "status": "error", "code": "SOME_CODE" } 格式,有时会附带解释具体情况的 message。请根据 code 分支处理,绝不要依赖 message。完整列表见错误。

全局错误

任何 Blob 路由也都可能返回以下错误:

限制与约束

了解 Square Cloud API 的限制与约束。