开发者指南
又拍云提供了丰富的 API 以及相关的 SDK 供开发者选择和使用,在使用这些资源之前,我们需要先对 又拍云产品做一些必要的了解,从而使得在实际操作过程中不会感到手足无措。
基本概念¶
注册帐号/操作员¶
「注册帐号」及其密码将作为 又拍云用户控制面板的登录所用,您需要通过「注册帐号」在 又拍云用户控制面板 进行服务的新建,操作员授权,订单购买等操作。
「操作员」,顾名思义,是用来操作您的服务的,通过使用注册帐号登录 又拍云用户控制面板 后,您可以创建多个操作员,满足不同的管理需求。
「操作员」需要被授权至某个服务,才能对该服务进行一些操作(如,上传,下载等)。帮助中心所涉及到的文档中,若无特殊说明,所指的「操作员」、「操作员名」均为已授权至相应服务的操作员。
「操作员」可以根据不同的需求赋予不同的权限,包括可读取、可写入、可删除, 你可以在管理后台右上角的帐号下拉菜单中选择账户管理->操作员管理->编辑
进行设置
服务名¶
在您使用注册帐号登录 又拍云用户控制面板 后,您可以创建不同的服务以方便管理你的文件资源,例如存储类型、自主源站服务等。
提示: 每个服务都可以授权多个操作员,相应的,每个操作员也可以被授权至多个服务
又拍云目前有如下几种服务类型:
- 存储类服务:可以上传任意资源,资源将被保存至 又拍云的服务器,且文件的外链将具有 CDN 网络支持。同时还提供「自定义版本」功能。
- 自主源站服务:资源文件全都存放在源站,无需重新上传至 又拍云服务器,适合源站内容动静混用的场景,可实现全站加速。
更多服务类型的区别,请参阅 服务分几种类型,有哪些区别?
访问域名¶
「服务」创建完成后,系统会自动绑定一个默认域名<bucket>.b0.upaiyun.com
。比如,当你创建了一个名叫demo
的服务时,那系统会自动绑定默认域名demo.b0.upaiyun.com
。因此,如果该服务根目录有一个名为 file.txt
的文件,那么,你可以使用 http://demo.b0.upaiyun.com/file.txt
来访问。
若你拥有已备案的域名,则可以绑定自己的独立域名。绑定独立域名后,你可以同时使用默认域名,以及你绑定的域名来访问你的文件。但是,我们强烈建议您使用自定义的域名去访问文件。
提示: 为了避免图片被盗链,可以根据实际需要,设置防盗链措施
防盗链¶
防盗链的相关设置请参考访问控制
缓存刷新¶
缓存刷新,您可参考缓存刷新
图片处理¶
缩略图版本作图¶
缩略图版本提供图片 「缩略图」 、 「水印」 、 「旋转」 、 「格式转换」等功能,它在 「管理后台」 > 「服务」 > 「功能配置」 > 「云处理」 > 「自定义版本」 中设置。
它的调用格式为:「图片 URL + 间隔标识符 + 缩略图版本名称」。
例如:
缩略图版本名称为: width200
,
间隔标识符为:!
,
规则为 限定宽度,高度自适应
、宽度值是 200
那么,调用这个版本的格式为:
http://demo.b0.upaiyun.com/img/demo.jpg!width200
这是一个拥有宽度为 200px 的图片。
URL 作图¶
URL 作图是把图片处理参数直接追加在图片 URL 后的一种作图方式。
它的调用格式为:「图片 URL + 间隔标识符 + 处理参数」。
例如:
处理参数为: /rotate/90
,间隔标识符为:_
那么,访问的 URL 为:
http://upyun-assets.b0.upaiyun.com/docs/guide/sample.jpg_/rotate/90 //图片旋转 90 度
效果如图
所有图片处理参数的说明,请参考 作图参数。
上传作图¶
此外,您也可以在上传图片的同时使用同步图片处理服务,在图片上传的请求中附加上图片处理参数,这样,图片在上传完成后会自动进行处理,并保存处理后的图片。如:
上传的图片,大小为:400x320
作图参数为:
'x-gmkerl-thumb: /fw/200/unsharp/true' //限定宽度,高度自适应;宽度值是200;锐化(高亮)图片
最终保存的图片,大小为:200x160
更多描述请见 上传同步作图。如果您需要保存上传的原图或者生成多张图片,可以参考 上传异步作图。
异步音视频处理¶
异步音视频处理是对已经上传到云存储中的音视频文件进行视频转码、音频转码、HLS 切片、视频截图、视频水印、元信息获取等处理,处理完成后,以回调的方式通知用户处理结果。 具体请参考 异步音视频处理。
如果需要在音视频文件上传的同时使用异步音视频处理服务,可以参考 上传预处理。
云安全¶
云安全参考云安全文档
服务方式¶
FTP/FTPS¶
又拍云提供了 FTP/FTPS 的方式,以方便用户通过图形化界面管理存储资源。
使用方法如下:
地址(主机): * 智能选路:v0.ftp.upyun.com * 电信线路:v1.ftp.upyun.com * 联通线路:v2.ftp.upyun.com * 移动线路:v3.ftp.upyun.com 加密:选择
不加密
使用 FTP,选择显式的 FTP over TLS
或TLS/SSL 显式加密
使用 FTPS 用户名:操作员名/服务名
,如operator/mybucket
密码:操作员的密码 端口:21
注:
- 编码方式(字符集):统一使用 UTF-8 。
- 使用
显式的 FTP over TLS
时,客户端会提示证书需要信任,选择是
或确定
即可。 - 使用
显式的 FTP over TLS
时,会对命令(用户名、密码、上传、下载等指令)进行加密。 - 当上传较大的文件时,出现进度是 100% 确没有显示上传完成的情况,请您耐心等待 15 秒左右,此时系统正在把接收到的文件写入您的存储服务中,文件写入完毕后,才会显示上传完成。
API¶
除了使用简单的 FTP 的方式之外,又拍云还提供了多种不同的 API,方便在不同的编程环境下使用又拍云服务,其中包括:
- HTTP REST API:该接口是基于标准 HTTP 协议的 API 接口,具备了文件资源的增删改查功能,建议在服务端使用
- HTTP FORM API:表单 API 接口更适用于移动 App 开发,丰富的参数接口和回调机制能够直接将终端用户的文件上传至 又拍云服务器,而不需要经过客户自己的服务器,大大提高了处理速度和用户体验
- 分块上传 API:在表单上传的基础上,在上传大文件的时候,面对有可能因为网络质量等其他原因而造成的上传失败,可以使用分块上传方式上传文件
- 缓存刷新 API:该功能只适用于 CDN 用户或 CDN 类服务。当源服务器的资源发生变更后,可以调用该 API 接口告知 又拍云缓存刷新,从而达到外网访问时获取到的是最新的资源
- 音视频预处理 API:音视频处理接口用于处理已经上传到对应存储服务中的音视频文件,进行转码、截图等操作。在处理完成之后,异步通知用户处理结果