Skip to content

读取 API

读取 API 用于通过统一路径访问已经存储在 CloudFlare ImgBed 中的文件。接口支持各存储渠道的文件读取、HEAD 请求、Range 分段读取,以及按 URL 参数缩放图片。

基本信息

  • 端点/file/{path}
  • 方法GETHEAD
  • 认证:普通文件通常无需认证;实际访问仍受域名白名单、文件黑白名单和内容审查配置限制
  • 响应内容:文件二进制内容

请求参数

路径参数

参数名类型必需说明
pathstring文件路径,例如 photo.jpgalbum/2026/photo.jpg;路径中的特殊字符应进行 URL 编码

Query 参数

参数名类型必需默认值说明
widthinteger-图片最大宽度,取值范围为 14096;可单独使用,此时保持原始宽高比
heightinteger-图片最大高度,取值范围为 14096;可单独使用,此时保持原始宽高比
fitstring-同时设置宽高时的适配方式:cover 按比例居中裁剪,squeeze 拉伸到指定尺寸;必须与 widthheight 一起使用
fallbackstring-仅支持 original;格式不受当前部署支持、源文件超限或处理失败时返回原文件,必须与图片尺寸参数一起使用
fromstring-设为 admin 时表示管理端预览,需要管理权限,普通文件读取不应设置此参数

不传 fit 时,widthheight 表示图片的最大边界:图片保持原始宽高比且不会放大。例如原图为 1600×900,请求 width=640&height=480 时返回 640×360

请求头

请求头必需说明
Range请求原文件的指定字节范围。不能与图片尺寸处理参数同时使用
Referer配置来源域名限制后用于防盗链检查
Authorization仅管理端预览等受保护场景需要

图片尺寸处理

注意

  • 格式支持:JPEG、PNG 和 WebP 可在所有部署方式中处理;AVIF 仅 Worker 和 Docker 支持,Pages 默认返回 415;GIF 仅 Docker 支持并保持 GIF 格式,Pages 和 Worker 默认返回 415;SVG 及其他格式不支持。
  • 大小限制:Worker 和 Docker 的待处理源文件最大为 20 MB;Pages 以 Cloudflare Images 当前限制为准。
  • 失败回退:使用 fallback=original 可在格式不支持、源文件超限或处理失败时返回原文件。
  • 配置说明:图片尺寸处理默认关闭,使用前请在配置说明 → 安全设置 → 访问管理中开启功能并配置允许尺寸。
  • 实际兼容性:实际支持情况以各渠道测试为准。

响应

成功的 GET 请求返回文件或处理后图片的二进制内容,Content-Type 根据实际输出格式设置;HEAD 请求只返回响应头。原文件的有效 Range 请求返回 206 Partial Content

常见响应头包括:

响应头说明
Content-Type文件或处理后图片的 MIME 类型
Content-Disposition默认为内联展示,并包含文件名
Cache-Control文件对应的缓存策略;尺寸处理不会改变原有策略
Access-Control-Allow-Origin值为 *,允许跨域读取

错误状态

状态码说明
400文件路径无法解码,尺寸或 fallback 参数无效、重复或缺少必要搭配,或尺寸处理与 Range 请求同时使用
401管理端预览未授权
403文件被访问规则拦截,或图片尺寸处理功能未开启
404文件不存在
405带尺寸参数的请求使用了 GET 以外的方法
413Worker 或 Docker 的待处理源文件超过 20 MB,且未设置 fallback=original
415当前部署不支持处理该图片格式,且未设置 fallback=original
416Range 请求的范围无效(适用于支持分段读取的存储渠道)
422图片处理失败,且未设置 fallback=original
500存储配置异常、源文件读取失败或分片文件重组失败
501当前部署未配置可用的图片处理器,且未设置 fallback=original

示例

读取原文件

bash
curl --location 'https://your.domain/file/album/example.jpg' \
--output example.jpg

按固定尺寸居中裁剪

html
<img src="https://your.domain/file/album/example.jpg?width=640&height=480&fit=cover&fallback=original" alt="示例图片">

基于 MIT 许可发布