术语说明

本节主要介绍API操作中经常涉及的术语。

存储空间（bucket）

存储空间是CDNetworks对象存储中的虚拟存储磁盘概念。每个存储空间可以包含多个文件，而存储空间名称是区分不同存储空间的唯一方式。

API说明： 在API文档中使用 bucket 来代替存储空间。

文件名（key）

文件名是CDNetworks对象存储平台用来描述资源的名称。文件名必须满足以下要求：

1. 最大长度为1000字节。
2. 文件名不能以 / 开头或结尾。
3. 不得包含特殊字符串 /…/ 或 /./。

与传统文件系统不同，对象存储是一个扁平文件系统，没有多级目录的概念，但是可以通过巧妙使用文件名来虚拟化路径结构。这也是对象存储平台的文件名与传统文件名略有不同的地方。

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

API说明： 在后续描述中，使用 key 来指代文件名。

资源（Resource）

资源是CDNetworks对象存储的一个存储数据单元，每个资源都有一个唯一的访问路径，由存储空间绑定的域名和文件名组合而成。

# 访问路径
http://<domain>/{key}

EncodeEntryURI 格式

EncodeEntryURI 指定了存储空间名称和资源名称。

# 语法规则
EntryURI=<bucket>:<key>
EncodeEntryURI=Urlsafe_Base64_Encode(EntryURI)

替换变量

特殊替换变量

特殊替换变量是CDNetworks对象存储预定义的一组变量，格式为 $(variable)。当平台获取到一个特殊替换变量时，会将其替换为平台已知的值，然后放入返回的结果中。

注意： 特殊替换变量的支持细节取决于具体的应用场景。详细支持信息请参考相应的应用场景文档。

示例

saveKey: $(year)/$(month)/$(hash)

如果当前时间为2016年4月，上传后的文件将被保存为 2016/04/<file-hash>。

---

特殊变量列表

变量	描述
$(fname)	上传的原始文件名
$(hash)	资源的 Etag
$(mimeType)	资源的 MIME 类型，例如 JPG 图片为 image/jpg
$(suffix)	资源后缀名，通过原文件的后缀来获取，若无后缀默认为 unknown
$(uuid)	随机数
$(year)	上传年份，例如 2015
$(month)	上传月份，例如 01
$(day)	上传日期，例如 01
$(hour)	上传小时，例如 01
$(min)	上传分钟，例如 01
$(sec)	上传秒钟，例如 01

自定义替换变量

自定义替换变量是由客户端在上传请求中指定的变量，格式为 $(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 中的原始值。

域名描述

上传域名 (Upload Domain)

通过上传域名上传文件，请登录CDNetworks控制台，进入“对象存储服务 -> 存储空间 -> 概览 -> 访问域名”获取。

管理域名 (Manage Domain)

通过管理域名操作文件，例如音视频处理、删除文件等，请登录CDNetworks控制台，进入“对象存储服务 -> 存储空间 -> 概览 -> 访问域名”获取。

CNAME回源域名（Origin Domain for CNAME）

该域名是一个CDN加速域名。用户需要将加速域名绑定到对象存储的存储桶，并通过此域名访问文件和查询信息。登录CDNetworks控制台，进入“对象存储服务 -> 存储空间 -> 概览 -> 访问域名”获取。

有关如何获取这三种域名的详细信息，请参阅查询域名。

文案约定

API文档采用一些约定以便于理解。

替换字符：
所有由尖括号 < > 包围的字符都是需要根据实际情况替换的字符。使用 < > 只是为了区分它们与其他字符，实际使用中不需要 < >。

例如，<deadline string> 表示需要用具体的字符串替换“deadline”。