术语说明

空间bucket

空间是网宿云存储的一个虚拟的存储磁盘概念,每个空间下可以存放多个文件,而空间名是区别空间的唯一方式。

空间名:image
空间类型:图片

注:API文档表述使用bucket代替空间。

空间类型buckettype

空间类型是网宿云存储平台用来描述存储文件类型的概念,便于用户对文件分类管理。具体分为网页类、大文件、流媒体、移动应用4种类型。

注:API文档表述使用buckettype代替空间类型。

文件名key

文件名是网宿云存储平台用来描述资源的名称信息。文件名需满足以下要求
1. 长度不大于1000字节
2. 不能以'/'作为开头和结尾
3. 不能包含'/../', '/./'特殊字符串

与传统的文件系统不太一样的地方是,云存储是一个扁平化的文件系统,没有多级文件目录的概念,但是可以巧妙的利用文件名实现虚拟化路径文件。这也是云存储平台文件名与传统文件名稍微不太一样的地方。

包含虚拟化路径的文件名:book/2.jpg

注:下文表述使用key代替文件名。

资源resource

资源是网宿云存储的一个存储数据单元,每个资源都有唯一路径来访问它,这个访问路径由空间绑定的域名和文件名组合而成。

http://<domain>/{key}

EncodeEntryURI格式

EncodeEntryURI用于指定空间名与资源名:

EntryURI=<bucket>:<key>
EncodeEntryURI=Urlsafe_Base64_Encode(EntryURI)

特殊替换变量

特殊替换变量是一组网宿云存储预先定义的变量,格式为$(variable)
当云存储平台获取到特殊替换变量时,会将该变量替换成平台知道的值,随后放入返回结果中。
注:对特殊替换变量的支持情况详见具体的应用场景说明

自定义替换变量

自定义替换变量是客户端在上传请求中设定的变量,格式为$(x:variable)
客户端的请求到达云存储平台后,平台会识别出自定义替换变量,这时会搜寻上传请求中的参数中是否存在相应名字的,并使用该参数值替换掉 $(x:variable)
注:自定义变量必须是UTF-8格式,且不能含有&,否则会解析为乱码

例如callbackBody中设定了自定义替换变量:
position= $(x:position)&message=$(x:message)
其中 $(x:position)$(x:message)是自定义替换变量,如x:position=4,x:message=upload,服务端会将请求中x:position和x:message的值,替换掉callbackBody中的原值。

域名说明

上传域名UploadDomain

通过上传域名进行文件上传,可在用户管理界面-安全管理-域名查询获取。
注:该上传域名为普通域名,若对上传速度较为敏感,有要求的客户建议采用网宿上传加速服务。

管理域名MgrDomain

通过管理域名进行文件操作,如:音视频处理、删除文件等,可在用户管理界面-安全管理-域名查询获取

访问域名DownloadDomain

该域名为CDN加速域名,用户需要将加速域名绑定到云存储空间,通过该域名进行文件访问,信息查询。

文案约定

对API文档上有一些约定的说明,以便您的理解。

替代字符:所有用尖括号<>包围的字符,均为需要根据实际情况做替换的地方,使用<>包围仅为了将其区分于其他字符,您在实际使用的时候,不需要加上 <>。
例如表示您需要使用一个string类型的字符串替代deadline