Blob S3 凭证

GET

credentials

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

string

必填

你账户的 API 密钥。你可以在账户设置中找到它。

S3 凭证会返回 S3 工具用于为发往 S3 网关的请求签名的访问密钥对。该密钥对由调用此路由的 API key 派生：再次调用会返回同一对密钥，撤销、重新生成 key 或 key 过期都会对密钥对产生同样的效果。没有其他需要轮换或撤销的东西。请使用拥有 blob:read 或 blob:write 的 API key 调用它。拥有 blob:read 时密钥对可以读取，拥有 blob:write 时可以写入，如 access 字段所示。

secret_access_key 提供与 API key 相同的访问权限。请像保管 key 本身一样保管它。

只要 API key 不变，密钥对就不会变。获取一次后将其保存在你的密钥管理器或环境变量中：不要在每次应用启动时都调用此路由。

速率限制

每个账户每小时 10 次请求（RATE_LIMITED，429）。

响应

string

成功为 “success”，否则为 “error”。

object

显示展开对象

string

访问密钥 id（SQ2_...）。

string

秘密访问密钥。

string

https://s3-blob.squarecloud.app

string

auto

string[]

你账户的 bucket：public、private 和 legacy。

object

read 和 write，各为 true 或 false，取决于 key 的 scope。

ISO 8601 | null

API key（因而也是该密钥对）的过期时间。不会过期时为 null。

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

错误

代码	HTTP	触发情况
`API_KEY_REQUIRED`	400	使用控制台会话调用。请使用 API key。
`LEGACY_API_KEY`	400	该 key 使用无法为 S3 请求签名的旧格式。请创建一个新的 API key。
`INVALID_CREDENTIAL`	401	无法验证该 API key。
`MISSING_SCOPE`	403	该 key 既没有 `blob:read` 也没有 `blob:write`。
`RATE_LIMITED`	429	一小时内超过 10 次请求。

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/s3/credentials' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "access_key_id": "SQ2_3155597145698959364_k7Hq2mX9",
    "secret_access_key": "vR8nLq2Wz5Tc1Yb7Hs0Kd4Jf6Gm3Pa9Xe",
    "endpoint": "https://s3-blob.squarecloud.app",
    "region": "auto",
    "buckets": ["public", "private", "legacy"],
    "access": { "read": true, "write": true },
    "expires_at": null
  }
}

入门

对象

分块上传

账户

分享链接

S3

速率限制

响应

错误

​速率限制

​响应

​错误

速率限制

响应

错误