FORM API

通过网页 FORM,使用 HTTP/HTTPS 直接把文件上传到又拍云存储。特别地,文中请求参数放在 HTTP/HTTPS body 中传递,请确保您上传表单格式符合 RFC 1867 协议规范。


请求方法

curl http://v0.api.upyun.com/<bucket> \
    -F authorization="UPYUN <Operator>:<Signature>" \
    -F file=@<filename> \
    -F policy=<policy> \
    # 其他参数...

基本域名

认证鉴权

详见签名认证

推荐上传流程

            +-----------------+ +-----------------+ +-----------------+
            | Client/Browser  | |    FORM API     | | Customer Server |
            +-----------------+ +-----------------+ +-----------------+
                    |                   |                   |
                    |                   |                   |
                   +++        Request authorization        +++
                   |-|====================================>|-|
                   |-|                  |                  |-|
                   |-|                  |                  |-|
                   |-|        Response authorization       |-|
                   |-|<====================================|-|
                   +++                  |                  +++
                    |                   |                   |
                    |                   |                   |
                    |                   |                   |
                   +++     Upload      +++                 +++
                   |-|================>|-|     Notify      |-|
                   |-|                 |-|---------------->|-|
                   |-|                 |-|                 |-|
                   |-|     Response    |-|                 |-|
                   |-|<================|-|                 |-|
                   +++                 +++                 +++
                    |                   |                   |
                    |                   |                   |                              
  1. 客户端请求客户服务器,生成、获取上传所需的 policyauthorization
  2. 客户端通过 FORM API 上传文件,返回上传结果信息,(可选)回调通知客户服务器;
  3. 客户端处理其他业务流程。

小文件上传

文件大小超过 100M 后,建议使用大文件上传;移动端或者弱网环境上传,推荐使用 REST API 断点续传上传

参数 必选 说明
bucket 文件上传到的服务
save-key 文件保存路径,可用占位符,见 路径设置
expiration 请求的过期时间,UNIX UTC 时间戳,单位秒。建议设为 30 分钟
date 请求日期时间,GMT 格式字符串 (RFC 1123),如 Wed, 29 Oct 2014 02:26:58 GMT
content-md5 上传文件的 MD5 值,如果请求中文件太大计算 MD5 不方便,可以为空
return-url 同步通知 URL,见 通知规则
notify-url 异步通知 URL,见 通知规则
content-secret 文件密钥,用于保护文件,防止文件被直接访问,见 Content-Secret 参数说明
content-type 文件类型,默认使用文件扩展名作为文件类型
allow-file-type 允许上传的文件扩展名,以 , 分隔。如 jpg,jpeg,png
content-length-range 文件大小限制,格式:min,max,单位:字节
102400,1024000,表示允许上传 100Kb~1Mb 的文件
image-width-range 图片宽度限制,格式:min,max,单位:像素
0,1024,允许上传宽度为 0~1024px 之间
image-height-range 图片高度限制,格式:min,max,单位:像素
0,1024,允许上传高度在 0~1024px 之间
x-gmkerl-thumb 图片预处理,见 上传预处理(同步)
x-gmkerl-type 可选值:get_meta,获取图片信息;get_theme_color,获取图片主题色
apps 异步预处理,见 异步预处理
b64encoded 对通过 Base64 编码上传的文件进行 Base64 解码,值为 on
ext-param 额外参数,见 ext-param
x-upyun-meta-ttl 文件元信息, 指定文件的生存时间, 单位天,最大支持180天


响应信息


通知规则

return-url 参数说明

http://yourdomain.com/return/?code=200&message=ok&url=%2F2011%2F12%2Ffd0e30047f81fa95.mp3&time=1332129461
参数 说明
code 状态码,200 表示上传成功
message URL encoding 的描述信息,ok 表示上传成功,其他的表示错误信息
url URL encoding 的文件保存路径
time UNIX UTC 时间戳,单位秒
sign/no-sign 签名,详见回调签名(旧)。使用回调签名(新)时,不存在
image-width 图片的宽。上传文件是图片时,才存在
image-height 图片的高。上传文件是图片时,才存在
image-type 图片类型。上传文件是图片时,才存在
image-frames 图片帧数。上传文件是图片时,才存在
task_ids 异步任务 ID 集。设置了 apps 参数时,才存在

notify-url 参数说明


大文件上传

大文件上传基于数据流式传输的原理,通过降低数据在边缘节点、中转节点的时间开销,让上传速度更快。

相比小文件上传,它有两点约束,具体如下:

1、需要在小文件上传的参数中加入 content-length 参数,指定文件长度。

2、确保三个字段 authorizationpolicyfile 中,file 处于最后的位置。

举例说明

// policy 中加入文件长度 content-length

POLICY = {
    'bucket': 'bucket1',
    'expiration': 1509200758,
    'content-length': 10,
    'save-key': '/img1.txt',
}
// file 字段处于最后的位置

POST /bucket1 HTTP/1.1
Host: v0.api.upyun.com
Content-Type: multipart/form-data; boundary=xxxxxxx
Content-Length: 386
--xxxxxxx.
Content-Disposition: form-data; name="policy"
eyJjb250ZW50LWxlbmd0aCI6IDEwLCAiYnVja2V0IjogImJ1Y2tldDEiLCAiZXhwaXJhdGlvbiI6IDE1MDkyMDA3NTgsICJzYXZlLWtleSI6ICIvaW1nMS50eHQifQ==
--xxxxxxx
Content-Disposition: form-data; name="signature"
48f7ccda45cc3a5e25f4eb5eb1d6dbba
--xxxxxxx
Content-Disposition: form-data; name="file"; filename=abc.txt.
d63..`PPq.
--xxxxxxx--

路径设置

save-key 支持的设置类型:

类型 格式 说明
绝对值 String 指定具体的路径,如: /path/to/file.txt
时间类 {year} {mon} {day} {hour} {min} {sec} 日期、时间相关内容(UTC 时间)
md5 类 {filemd5} 文件的 md5 值
随机类 {random} {random32} 16 位或 32 位随机字符和数字
文件名 {filename} {suffix} {.suffix} 上传文件的文件名及扩展名

举例说明

例 1:时间类 + 随机类

上传文件名:sample.jpg
UTC 时间:2013-01-01 10:05:20
save-key:/{year}/{mon}/{day}/upload_{random32}{.suffix}
保存路径为:/2013/01/01/upload_b92c9cc21ce6a88ea696705c88b57c3f.jpg

例 2:时间类 + 文件名

上传文件名:sample.jpg
UTC 时间:2014-02-02 11:05:20
save-key:/{year}/{mon}/{day}/{hour}_{min}_{sec}_{filename}{.suffix}
保存路径为:/2014/02/02/11_05_20_sample.jpg

为了避免路径重名导致文件被覆盖,建议使用复杂的低重复性的命名方式。


异步预处理

如果设置了 apps 参数,文件上传完成后,会创建异步处理任务。目前,异步预处理支持异步图片处理异步音视频处理异步图片鉴别

apps 参数结构

apps = [
    {                                           // 异步图片处理任务
        "name": "thumb",                        // 异步任务名称,必填。thumb 表示异步图片处理服务
        "x-gmkerl-thumb": "<图片处理参数>",       // 处理参数,必填
        "save_as": "<save_as>",                 // 结果图片保存路径,选填
        "notify_url": "<notify_url>"            // 回调地址,不填时使用上传参数中的  notify_url
    },
    ......
]

apps = [
    {                                               // 异步音视频处理任务
        "name": "naga",                             // 异步任务名称,必填。naga 表示异步音视频处理服务
        "type": "<type>",                           // 视频转码,必填
        "avopts": "<avopts>",                       // 处理参数,必填
        "return_info": true/false,                  // 是否返回元数据,选填
        "save_as": "<save_as>",                     // 结果音频/视频保存路径,选填
        "notify_url": "<notify_url>"                // 回调地址,不填时使用上传参数中的 notify_url
    },
    ......
]

apps = [
    {                                               // 异步内容审核任务
        "name": "imgaudit",                         // 异步任务名称,必填。imgaudit 表示异步内容审核服务
        "notify_url": "<notify_url>"                // 回调地址,不填时使用上传参数中的 notify_url
    },
    ......
]


响应信息

异步处理任务创建成功后,在上传返回信息和回调信息(详见通知规则)中会带上 task_ids 字段,里面包含每个任务的 task_id


回调通知

异步处理任务完成后,如果存在 notify_url(任务中不存在 notify_url,使用上传参数中的 notify_url,如果上传参数中也不存在,不回调),以回调的形式发送处理结果,里面包含 task_id 等信息,具体详见各服务的回调通知。


ext-param

当使用 return-urlnotify-url 参数发送返回信息或回调信息时,结果信息(详见通知规则)仅包含又拍云指定的内容,无法回传用户自定义的内容。如果需要回传自定义的内容,可以指定 ext-param 参数。


签名认证(旧)

请求签名(旧)

请求方法

curl http://v0.api.upyun.com/<bucket> \
    -F file=@<filename> \
    -F policy=<policy> \
    -F signature=<signature> \
    # 其他参数...

signature 算法

为了保证服务的安全性,使用服务的表单 API 密钥(可登录又拍云控制台查看)对 policy 进行签名,签名的结果即是 signature。

signature 生成步骤:

  1. 生成 policy 字符串(见 policy 算法);
  2. 将第 1 步中的字符串与表单 API 密钥字符串用 & 拼接;
  3. 将第 2 步中的字符串计算 md5,所得即为 signature

例如,假设服务的表单 API 验证密钥为:cAnyet74l9hdUag34h2dZu8z7gU=

第一步,生成 policy 字符串:

eyJidWNrZXQiOiJkZW1vYnVja2V0IiwiZXhwaXJhdGlvbiI6MTQwOTIwMDc1OCwic2F2ZS1rZXkiOiIvaW1nLmpwZyJ9

第二步,第一步的字符串与表单 API 密钥字符串用 & 拼接:

eyJidWNrZXQiOiJkZW1vYnVja2V0IiwiZXhwaXJhdGlvbiI6MTQwOTIwMDc1OCwic2F2ZS1rZXkiOiIvaW1nLmpwZyJ9&cAnyet74l9hdUag34h2dZu8z7gU=

第三步,将第二步的字符串计算 md5 后即得到 signature

646a6a629c344ce0e6a10cadd49756d4

回调签名(旧)

sign 算法

sign 是根据 codemessageurltime 和表单 API 验证密匙(form_api_secret) 使用 & 拼接后进行 MD5 处理得到。拼接时需注意 URL 的编码与解码问题。如果使用了 ext-param 参数, ext-param 也需要使用 & 拼接在 form_api_secret 之后。

如果上传的是图片,存在 image-widthimage-heightimage-framesimage-type 四个参数,这四个参数不参与签名计算。 如果设置了 apps 参数,存在 task_ids,它也不参与签名计算。

例如,code:200

message:'ok'

url:'/2015/06/17/190623/upload_QQ 图片 201506011111206f7c696f0920f097d7eefd750334003e.png'

time:1434539183

form_api_secret:lGetaXubhGezKp89+6iuOb5IaS3=

拼接后的字符串:

200&ok&/2015/06/17/190623/upload_QQ 图片 201506011111206f7c696f0920f097d7eefd750334003e.png&1434539183&lGetaXubhGezKp89+6iuOb5IaS3=

sign'086c46cfedfc22bfa2e4971a77530a76'

回调信息(已经签名)是:

{"code":200,"message":"ok","url":"\/2015\/06\/17\/190623\/upload_QQ\u56fe\u7247201506011111206f7c696f0920f097d7eefd750334003e.png","time":1434539183,"image-width":1024,"image-height":768,"image-frames":1,"image-type":"PNG","sign":"086c46cfedfc22bfa2e4971a77530a76"}

no-sign 算法

如果发生异常,表单 API 验证密钥获取失败,返回 no-signno-sign 算法跟 sign 相同,只是表单 API 验证密匙(form_api_secret) 为空字符串 ''

例如,使用上例参数拼接后的字符串是:

200&ok&/2015/06/17/190623/upload_QQ 图片 201506011111206f7c696f0920f097d7eefd750334003e.png&1434539183

no-sign'bbaeeb9d05623fe1b380f756a291011a'


图片预处理(旧)

参数 必选 说明
x-gmkerl-extract-color-count 主题色提取的颜色数量,默认 256
x-gmkerl-extract-format 主题色提取格式,默认 dec
x-gmkerl-thumbnail 缩略图版本名称,可搭配其他 x-gmkerl-* 参数使用
x-gmkerl-type 缩略类型,见 x-gmkerl-type 可选值列表
x-gmkerl-value 缩略类型对应的参数值,见 x-gmkerl-value 值说明
x-gmkerl-quality 压缩质量,默认 95
x-gmkerl-unsharp 是否锐化,默认锐化
x-gmkerl-rotate 图片旋转(顺时针),可选值:auto(0, 360]。详见旋转
x-gmkerl-crop 图片裁剪,格式:<w>x<h>a<x>a<y>。详见裁剪
x-gmkerl-exif-switch 是否保留 EXIF 信息,默认不保留
仅在搭配 x-gmkerl-cropx-gmkerl-typex-gmkerl-thumbnail 时有效

x-gmkerl-type 可选值列表

含义
fix_width 限定宽度,高度自适应
fix_height 限定高度,宽度自适应
fix_width_or_height 限定宽度和高度,宽高不足时不缩放
fix_both 固定宽度和高度,宽高不足时强行缩放
fix_max 限定最长边,短边自适应
fix_min 限定最短边,长边自适应
fix_scale 等比例缩放(1-1000)

x-gmkerl-value 值说明


如有疑问请 联系我们