GB/T36623-2018
信息技术云计算文件服务应用接口
Informationtechnology—Cloudcomputing—Fileserviceapplicationinterface
- 中国标准分类号（CCS）L79
- 国际标准分类号（ICS）35.100.05
- 实施日期2019-04-01
- 文件格式PDF
- 文本页数52页
- 文件大小2.22M
以图片形式预览信息技术云计算文件服务应用接口
信息技术云计算文件服务应用接口
国家标准 GB/T36623一2018 信息技术云计算文件服务应用接口 nformationtechnology一 -CIoudcomputing一Fileservieeapplieationinterfae 2018-09-17发布 2019-04-01实施 国家市场监督管理总局 发布 国家标准化管理委员会国家标准
GB/36623一2018 目 次 前言 范围 2 规范性引用文件 术语和定义 概述 基本要求 5.1创建文件夹 5.2 获取文件列表 5.3上传文件 5. 下载文件(夹 5.5 复制文件(夹 5.6 移动文件(夹 .7删除文件(夹) 6 扩展要求 获取回收站列表 6.l 6.2还原文件(夹 6.3彻底删除文件(夹 6.4批量复制文件(夹 6.5批量移动文件(夹 6.6批量删除文件(夹) 6.7批量下载文件(夹 6.8搜索 6.9创建分享 6.10获取分享列表 6.11获取分享文件 6.12取消分享 6.13获取图片文件缩略图 6.14！查看历史版本 6.15恢复文件 附录A规范性附录文件服务应用接口定义 附录B资料性附录)文件服务应用接口示例 35
GB/36623一2018 前 言 本标准按照GB/T1.1一2009给出的规则起草
本标准由全国信息技术标准化技术委员会(SAC/TC28)归口
请注意本文件的某些内容可能涉及专利
本文件的发布机构不承担识别这些专利的责任
本标准起草单位:华中科技大学、电子技术标准化研究院、深圳市迅雷网络技术有限公司、深圳 市腾讯计算机系统有限公司、浪潮(北京)电子信息产业有限公司、电子科技集团公司第二十八研究 所,华为技术有限公司、中兴通讯股份有限公司、上海计算机软件技术开发中心、深圳市金蝶天燕中间件 股份有限公司、科学院深圳先进技术研究院、深圳赛西信息技术有限公司、东莞市中电云华信息技 术有限公司、阿里云计算有限公司
本标准主要起草人周可、陈志峰,王桦、刘汉洲、肖志立,赵江、严红,周景才,胡捷、蔡立志、林琳 吴涛、王志鹏、杨丽蕴、王典威、李振岭、刘海军、王兆春、孙思、陈伟、冯超、黄永峰、喻之斌,刘琪骁 易晶晶、王学英、谢天杰、苏志远
GB/36623一2018 信息技术云计算文件服务应用接口 范围 本标准规定了文件服务应用接口的基本要求和扩展要求
本标准适用于基于文件的云服务应用的开发、测试和使用
规范性引用文件 下列文件对于本文件的应用是必不可少的
凡是注日期的引用文件,仅注日期的版本适用于本文 件
凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件
GB/T324002015信息技术云计算概述和词汇 RFc822电子邮件的标准格式(StandardForTheFormatofARPAINTERNETTextMessa- geS TransferProtocol1.1 RFC2616超文本传输协议1.1(Hypertext oteAuthenticationDialIn RFC4672远程用户拨号认证动态认证客户端管理信息基础(Reme UserServiceDynamicAuthorizationClient InformationBase Managementl 术语和定义 GB/T32400-2015界定的以及下列术语和定义适用于本文件
3.1 file 文件 存放在计算机存储介质中,具有符号名,且在逻辑上具有完整意义的数据集合 3.2 文件夹toder 存储系统中存储文件的逻辑空间 3.3 fileservyiee 文件服务 -种以文件为单位的数据服务形式
3,4 文件服务应用接口ileservieapplieation interface 文件服务为应用提供的接口
概述 文件服务应用接口由基本接口和扩展接口组成,其中基本接口是每个文件服务都应该具备的接口 扩展接口是文件服务宜具备的接口
文件服务应用接口定义见附录A,文件服务应用接口示例参见附录B
GB/T36623一2018 5 基本要求 5.1创建文件夹 创建文件夹时提供以下功能 a 应能够选择文件夹地址; b应能够设置文件夹名字; c 创建文件夹后应能够查看创建时间和最后修改时间 宜支持同时创建多个文件夹功能
d 5.2获取文件列表 获取文件列表时提供以下功能 应能够选择获取文件夹的地址; a b 应能够选择每页显示文件(夹)数量 应能够选择显示的页数; d 应能够查看文件(夹)大小,创建时间和最后修改时间; 宜支持分页时根据修改时间、文件大小和文件名字进行排序功能 e fD 宜支持按文件(夹)类型查询
5.3 上传文件 上传文件时提供以下功能: 应能够选择上传文件地址 a) b) 应能够支持覆盖、不准许覆盖和自动覆盖等模式; 宜支持文件校验功能
c 5.4下载文件(夹 下载文件(夹)时提供以下功能 应能够选择下载文件(夹)的地址: a D)宜支持选择下载文件的版本 c 宜支持文件校验功能
5.5复制文件(夹 复制文件(夹)时提供以下功能 应能够选择源文件(夹)和目标文件(夹)地址; a b应能够支持覆盖、不准许覆盖和自动覆盖等模式 5.6移动文件(夹 移动文件(夹)时提供以下功能 应能够选择文件(夹)源地址和目标地址; a 应能够支持覆盖、不准许覆盖和自动覆盖等模式
b) 5.7删除文件(夹 删除文件(夹)时提供以下功能:
GB/36623一2018 应能够选择文件(夹)地址; a b 宜支持选择删除方式;彻底删除或者放人回收站
扩展要求 6.1获取回收站列表 获取回收站列表时提供以下功能 应能够选择获取列表每页显示文件数量; a 应能够选择显示的页数 b) 应能够查看回收站中文件大小,创建时间和最后修改时间 c 宜支持分页时根据修改时间、文件大小和文件名字进行排序功能 d 6.2还原文件(夹 还原文件(夹)时提供以下功能 应能够选择还原文件(夹); a b 宜支持同时还原多个文件(夹)功能 6.3彻底删除文件(夹 彻底删除文件(夹)时提供以下功能 应能够选择删除文件(夹)地址; a b)宜支持同时删除多个文件(夹)功能 6.4批量复制文件(夹 批量复制文件(夹)时提供以下功能 应能够选择多对源文件(夹)地址和目标地址 a b 应能够支持覆盖,不准许覆盖、自动覆盖等模式
6.5批量移动文件夹 批量移动文件(夹)时提供以下功能 应能够选择多对源文件(夹)地址和目标地址; aa b)应能够支持覆盖、不准许覆盖和自动覆盖等模式
6.6批量删除文件(夹) 批量删除文件(夹)时提供以下功能 应能够选择多个文件(夹)地址 a 应能够选择删除方式;彻底删除或者放人回收站
b) 6.7批量下载文件(夹 批量下载文件(夹)时提供以下功能 应能够选择多个下载文件(夹)的地址; a b 宜支持选择下载文件的版本; 宜支持文件校验功能
c
GB/T36623一2018 6.8搜索 搜索时提供以下功能: 应能够指定搜索文件夹地址 a b 应能够选择搜索关键字; 搜索成功后应能够查看文件路径,大小、创建时间和最后修改时间信息 c d 宜支持模糊搜索功能
6.9创建分享 创建分享时提供以下功能 应能够选择分享文件(夹)地址; a b应能够查看分享文件(夹)的下载页面 宜支持获取文件(夹)身份鉴别功能,如密码认证
c 6.10获取分享列表 获取分享列表时提供以下功能 aa 应能够选择获取分享文件夹的地址; 5 应能够选择获取列表每页显示文件数量; 应能够选择显示的页数; c 应能够查看分享文件(夹)的下载页面 宜支持查看文件(夹)的分享时间
6.11获取分享文件 获取分享文件时提供以下功能 a 应能够指定分享文件(夹)的下载页面地址; b)宜支持身份鉴别功能,如:密码认证; 宜支持文件校验功能
c 6.12取消分享 取消分享时提供以下功能 应能够指定取消分享文件(夹)地址 a) b)宜提供根据分享时间取消分享功能
6.13获取图片文件缩略图 获取图片文件缩略图时提供以下功能 应能够指定要获取缩略图的文件地址 a b)应能够指定缩略图高度和宽度
6.14查看历史版本 查看历史版本时提供以下功能 应能够选择文件的地址; a b)应能够查看文件各版本的创建时间和最后修改时间
GB/36623一2018 6.15恢复文件 恢复文件时提供以下功能 应能够选择文件旧版本; a b)恢复文件后应能够查看文件的创建时间和最后修改时间
GB/T36623一2018 附 录 A 规范性附录) 文件服务应用接口定义 A.1接口描述 A.1.1支持接口类型 本附录在POSIX接口标准的基础上定义了REST接口,以基于HTTP1.1版本(见RFC2616) 为例
A.1.2认证要求 提供认证机制,保障客户端和服务器之间的身份鉴别
A.1.3状态码 指示错误类型
给出了一组在文件服务应用接口中推荐使用的HTTP接口状态码见表A.1
表A.1状态码 含义 编码 描述 200OK,成功 Noerror,没有错误 400BadRequest,错误的请求 Missingorinvalidrequestcontents,请求内容缺失或无效的请求内容 401Unathorized,无权限 Invalidauthentication/authorizationcredentials s,权限无效 Thisuserisnotallowedtoperformthisrequest 403Forbiden,禁止 t,不准许执行当前请求 404NotFound,没有发现 Requestedresourcenotfound,请求的资源没有找到 MethodNotAlowed,操作不准许 405 RequestedHTTPverbnotallowedonthisresouree,对资源的操作不准许 Therequestwouldcauseaninvalidstatetransitionontheserver,由于和被 409 Conliet,冲突 请求的资源的当前状态之间存在冲突,请求无法完成 EantityTooL.arge,请求Request Large,服务器拒绝处理当前请求,因为该请求提交的实 EaityToo Request 413 数据太大 体数据大小超过了服务器愿意或者能够处理的范围 InternalServerEror,服务器内 Anunexpeetedvendorspeeificerror,服务器遇到了一个未曾预料的状况,导 500 部错谈 致了它无法完成对请求的处理 Enough,用户空间不够 Thespaceisnotenough,用户空间不够 507 Not A.1.4通用请求头格式 文件服务应用接口的HTTP请求头格式描述见表A.2
GB/36623一2018 表A.2请求头格式 名称 描述 是否必选 主机信息,如ls.china.comm Host 必选 取决于是否有实际内容,对于有内容的 请求消息内容长度(不含消息头) 请求,如PUT操作,本参数必选;无内 Content-l.ength 容的请求,如DELETE操作,可选 表示文档属于什么MIME类型,特殊的JsoN格式由 Content-Type 可选,情况同Content-length RFC4672定义;applieation/json 请求发起端的日期和时间,时间的描述格式由RFC822 必选 Date 定义,如:Sun，18Nov200606:l2;00GMT 授权信息,包含鉴权方信息,例如3 Authorization Authorizationm 必选 FBS" Access_token 十 Signature A.1.5响应头格式 文件服务应用接口的HTTP响应头格式描述见表A.3
表A.3响应头格式 名称 描述 是否必选 取决响应消息内容,对于有内容的 Content-Length 响应消息内容长度(不含消息头 响应,本参数必选;无内容的响应， 可选 表示文档属于什么MIME类型,特殊的JSON格式由 可选 Content-Type RFC4672定义:applieation/json 消息响应的时间,时间的描述格式由RFC822定义,如: Date 必选 Sun，18Nov200606:12:00GMT Server 处理请求的原始服务器的信息 可选 标明客户端与服务器之间的链接状态 类型:枚举 可选 Connection 有效值;keepalivelclose 默认值;无 由系统创建,并唯一标示这个响应,用来错误追踪 x-FBSrequestid 可选 类型:字符串 默认值;无 A.1.6错误响应要求 REST请求的处理如果出现错误,除了在响应消息的状态码中指示错误类型,还可把错误信息放在 响应消息体中,用JSON描述错误信息,文档类型设为applieation/json
错误响应格式描述见表A.4
GB/T36623一2018 表A.4错误响应格式描述 名称 类型 描述 必选/可选 error_code 字符串 返回给用户自定义的错误码 必选 字符串 FS给出的详细错误信息 error_msg 必选 字符串 该错误相关的文件资源 可选 resource os_id 字符串 该消息的服务端D 可选 带错误信息的响应体见示例
示例: 带错误信息的响应体; errorcode""31472" "Filetobeuploadedexceedsthemaximumallowedobjeetsize" error_mmsg "myfole "resource der/myvideo.mpg” "host_id";”B56GQkQ4OUY3MTI4NTQ3NDk2M” A.2基本接口 A.2.1创建文件夹 A.2.1.1功能描述 为用户创建一个文件夹
A.2.1.2请求消息 请求消息见示例
示例" 请求消息: PUT HTTP/1.1
GB/36623一2018 表A.5创建文件夹的请求参数 名称 类型 描述 必选/可选 method 字符串 固定值:mkdir 必选 A.2.1.5消息头附加域 无 A.2.1.6请求体参数 无 A.2.1.7响应参数 无 A.2.1.8响应消息体参数 创建文件夹的响应消息体参数见表A.6
表A.6创建文件夹的响应消息体参数 名称 类型 描述 必选/可选 字符串 fsid 文件夹的唯一标识id 可选 字符串 文件或文件夹的绝对路径 可选 path create_time 字符串 文件或文件夹创建时间 可选 modify_time 字符串 文件或文件夹最后修改时间 可选 A.2.2获取文件列表 A.2.2.1功能描述 用户获取文件夹中的文件和子文件夹 A.2.2.2请求消息 请求消息见示例
示例: 请求消息 GET
GB/T36623一2018 请求URL http://fbs.china.com/
GB/36623一2018 表A.8(续 名称 类型 描述 必选/可选 字符串 create_time 文件或文件夹创建时间 可选 字符串 文件或文件夹最后修改时间 可选 modify_tie 文件的MD5值 MD5 字符串 可选 它是一个数组,以JsON串的形式显示所获取到的文件 children 数组 可选 或文件夹的具体信息 A.2.3 上传文件 A.2.3.1功能描述 上传单个文件
A.2.3.2请求消息 请求消息见示例 示例: 请求消息: PUT HTTP/1.1
GB/T36623一2018 A.2.3.5消息头附加域 上传文件的消息头附加域见表A.10. 表A.10上传文件的消息头附加域 名称 类型 描述 必选/可选 字符串 对消息的内容作MI5校验,防止数据中途损坏 Content-MD5 可选 A.2.3.6请求体参数 无 A.2.3.7响应参数 无 A.2.3.8响应消息体参数 上传文件的响应消息体参数见表A.11 表A.11上传文件的响应消息体参数 类型 必选/可选 名称 描述 字符串 文件的唯一标识id fs_id 必选 字符串 Dath 文件或文件夹的绝对路径 必选 字符串 文件大小 可选 size 字符串 文件或文件夹创建时间 可选 create_timme modify_time 字符串 文件或文件夹最后修改时间 可选 MD5 字符串 文件的MD5值 可选 A.2.4 下载文件(夹 A.2.4.1功能描述 获取单个文件(夹)的内容
A.2.4.2请求消息 请求消息见示例
示例: 请求消息: GET
GB/36623一2018 示例 请求URL. /<四th> http://hs.china.com/< 其中
GB/T36623一2018 示例: 请求消息 PUT
GB/36623一2018 表A.16续 名称 类型 描述 必选/可选 字符串 复制的源地址,包含文件(夹)名 from 可选 字符串 复制的目标地址,包含文件(夹) 可选 patlh )名 A.2.6移动文件(夹 A.2.6.1功能描述 通过移动或重命名的方式上传文件(夹)
与复制文件不同,移动(重命名)后不保留源文件(夹. A.2.6.2请求消息 请求消息见示例
示例: 请求消息 PUT
GB/T36623一2018 A.2.6.6请求体参数 无 A.2.6.7响应参数 无 A.2.6.8响应消息体参数 移动文件(夹)的响应消息体参数见表A.18
表A.18移动文件(夹)的响应消息体参数 名称 类型 描述 必选/可选 fs_idl 目标文件(夹)的唯一标识id 字符串 可选 字符串 移动的源地址,包含文件(夹)名 可选 irom path 字符串 移动的目标地址,包含文件(夹)名 可选 A.2.7删除文件(夹) A.2.7.1功能描述 删除单个文件(夹). A.2.7.2请求消息 请求消息见示例
示例 请求消息 PUT
GB/36623一2018 表A.19删除文件(夹)的请求参数 名称 类型 描述 必选/可选 字符串 method 固定值;delete 必选 可选值;true、alse
默认true 枚举 可选 reserve rue表示删除的文件(夹)放人回收站,空间不回收;false 表示彻底制除,并释放相应空间 A.2.7.5消息头附加域 无 A.2.7.6请求体参数 无 A.2.7.7响应参数 无 A.2.7.8响应消息体参数 无 A.3增强接口 A.3.1获取回收站列表 A.3.1.1功能描述 用户获取回收站中的文件与文件夹列表
A.3.1.2请求消息 请求消息见示例
示例: 请求消息 GET/?method=listrecycleHTTP/1.l Host:fbs,china.com Datedate Authorization:signatureValue A.3.1.3请求参数 获取回收站列表的请求参数见表A.20. 17
GB/T36623一2018 表A.20获取回收站列表的请求参数 类型 必选/可选 名称 描述 method 字符串 固定值:listrecycle 必选 和page_size一起使用,表示请求页数,从1开始，默认 整型 可选 page 值;0(表示不分页 page_size 整型 当page不等于0时有效,表示每页显示的文件内容大小可选 只有在分页时才有效,作为排序依据
可选值:time(修改时间size(文件大小),name(文件名 枚举 可选 sort_by 字),前面加上r表示从大到小,如: sort_by=rsize,否则表示从小到大 s_id 字符串 指定要查询的文件(夹)信息的唯一标识id 可选 A.3.1.4消息头附加域 无 A.3.1.5请求体参数 无 A.3.1.6响应参数 无 A.3.1.7响应消息体参数 获取回收站列表的响应消息体参数见表A.21
表A.21获取回收站列表的响应消息体参数 名称 类型 描述 必选/可选 字符串 文件或文件夹的唯一标识id s_idl 必选 可选值true,flse is_dir 枚举 必选 rue表示文件夹,false表示文件 字符串 文件或文件夹的绝对路径 可选 path 字符串 文件大小 可选 size 字符串 可选 ereatetime 文件或文件夹创建时间 modify_time 字符串 文件或文件夹最后修改时间 可选 MD5 字符串 文件的MD5值 可选 它是一个数组,以JsoN串的形式显示所获取到的回收 hildren 数组 可选 站文件或文件夹的具体信息 18
GB/36623一2018 A.3.2还原文件(夹 A.3.2.1功能描述 从回收站还原文件(夹 A.3.2.2请求消息 请求消息见示例
示例: 请求消息: PUT/?method=restore HTTP/1.1 HostHostServer Content-length:length Date:date Authorization:signatureValue "children":L "fsid":id A.3.2.3请求参数 还原文件(夹)的请求参数见表A.22.
表A.22还原文件(夹)的请求参数 名称 类型 描述 必选/可选 字符串 固定值;restore 必选 method 字符串 文件或文件夹的唯一标识id 必选 fsid 它是一个数组,以JSON串的形式显示所获取到的回收 children 数组 可选 站文件或文件夹的具体信息 A.3.2.4消息头附加域 无 A.3.2.5请求体参数 无 A.3.2.6响应参数 无 A.3.2.7响应消息体参数 还原文件(夹)的响应消息体参数见表A.23
19
GB/T36623一2018 表A.23还原文件(夹)的响应消息体参数 名称 类型 描述 必选/可选 s_idl 字符串 文件或文件夹的唯一标识id 可选 字符串 文件或文件夹的绝对路径 可选 pat山 它是一个数组,以Js(ON串的形式显示所获取到的回收 childrenm 数组 可选 站文件或文件夹的具体信息 A.3.3彻底删除文件夹 A.3.3.1功能描述 从回收站彻底删除文件(夹). A.3.3.2请求消息 请求消息见示例
示例: 请求消息" PUT
GB/36623一2018 A.3.3.5消息头附加域 无 A.3.3.6请求体参数 无 A.3.3.7响应参数 无 A.3.3.8响应消息体参数 无 A.3.4批量复制文件(夹 A.3.4.1功能描述 通过拷贝的方式上传多个文件(夹) A.3.4.2请求消息 请求消息见示例
示例 请求消息 PUT/?method=copy HTTP/1.1 Host:HostServer Date:date Authorization:signatureValue Content-Type:applieation/jsonm Content-l.ength:length "batch":C "from";"path" "to";"path" from";"path" "to";"path" A.3.4.3请求参数 批量复制文件(夹)的请求参数见表A.25
21
GB/T36623一2018 表A.25批量复制文件(夹)的请求参数 名称 类型 描述 必选/可选 字符串 固定值:copy method 必选 以JsON数组格式表示的源文件地址和目标地址的对 batch 字符串 必选 应列表
from:源地址;to:目标地址 A.3.4.4消息头附加域 无 A.3.4.5请求体参数 无 A.3.4.6响应参数 无 A.3.4.7响应消息体参数 批量复制文件(夹)的响应消息体参数见表A.26
表A.26批量复制文件(夹)的响应消息体参数 名称 类型 描述 必选/可选 字符串 fsid 文件或文件夹的唯一标识id 可选 children 数组 以JsON串的形式显示复制文件或文件夹的具体信息 可选 A.3.5批量移动文件夹 A.3.5.1功能描述 批量移动文件(夹) A.3.5.2请求消息 请求消息见示例
示例 请求消息: PUT/?tmethod=moveHTTP/1.1 Host:HostServer Date:date Authorization;signatureValue Content-Type:applieation/json Content-lengthlength "bateh";[ 22
GB/36623一2018 "from";"path" "to""path" "from";"path"" to""path" A.3.5.3请求参数 批量移动文件(夹)的请求参数见表A.27
表A.27批量移动文件(夹)的请求参数 名称 类型 描述 必选/可选 method 字符串 固定值;move 必选 以JSON数组格式表示的源文件地址和目标地址的对 字符串 batch 必选 应列表
from;源地址;to;目标地址 A.3.5.4消息头附加域 A.3.5.5请求体参数 无 A.3.5.6响应参数 无 A.3.5.7响应消息体参数 批量移动文件(夹)的响应消息体参数见表A.28
表A.28批量移动文件(夹)的响应消息体参数 描述 名称 类型 必选/可选 字符串 文件或文件夹的唯一标识d 可选 fsid children 数组 以JsoN串的形式显示复制文件或文件夹的具体信息 可选 A.3.6批量删除文件(夹 A.3.6.1功能描述 批量删除文件(夹)
A.3.6.2请求消息 请求消息见示例
23
GB/T36623一2018 示例: 请求消息 PUT/?method=deleteHTTP/1.l Host:HostServer Date;date Authorization:signatureValue Content-Type:application/jsonm Content-l.ength:length "batch" "path";"path1" "path";"path2" A.3.6.3请隶参数 批量删除文件(夹)的请求参数见表A.29
表A.29批量删除文件(夹)的请求参数 名称 类型 描述 必选/可选 method 字符串 固定值;move 必选 以JsoN数组格式表示的源文件地址和目标地址的对 字符串 必选 batch 应列表
path;文件(夹)路径 A.3.6.4消息头附加域 无 A.3.6.5请求体参数 无 A.3.6.6响应参数 无 A.3.6.7响应消息体参数 无 A.3.7批量下载文件(夹 A.3.7.1功能描述 批量下载文件(夹). 24
GB/36623一2018 A.3.7.2请求消息 请求消息见示例
示例 请求消息 PUT/?method=downloadHTTP/1.l Host:HostServer Date;date Authorization:signatureValue Content-Type;appieation/jsonm Content-length:length ”bateh": "path";"pathl" "path";"path2" A.3.7.3请求参数 批量下载文件(夹)的请求参数见表A.30 表A.30批量下载文件(夹)的请求参数 描述 名称 类型 必选/可选 method 字符串 固定值dowmload 必选 以JSON数组格式表示的源文件地址和目标地址的对 bateh 字符串 必选 应列表
path;文件(夹)位置 A.3.7.4消息头附加域 无 A.3.7.5请求体参数 无 A.3.7.6响应参数 无 A.3.7.7响应消息体参数 无 25
GB/T36623一2018 A.3.8搜索 A.3.8.1功能描述 在指定文件夹中根据名称搜索文件(夹). A.3.8.2请求消息 请求消息见示例
示例: 请求消息 GET
GB/36623一2018 表A.32搜索的响应消息体参数 类型 名称 描述 必选/可选 字符串 文件或文件夹的唯一标识id 必选 fsid 可选值;true,talse .dir 枚举 必选 Is true表示文件夹;false表示文件 path 字符串 文件或文件夹的绝对路径 必选 字符串 文件大小 可选 S1ze 字符串 文件或文件夹创建时间 可选 create_time modify_timme 字符串 文件或文件夹最后修改时间 可选 文件的MD5值 MD5 字符串 可选 它是一个数组,以JS(ON串的形式显示所获取到的回收 dhildren 数组 可选 站文件或文件夹的具体信息 A.3.9创建分享 A.3.9.1功能描述 创建并获取一个文件(文件夹)的分享链接
A.3.9.2请求消息 请求消息见示例
示例: 请求消息 PUT
GB/T36623一2018 表A.33创建分享的请求参数 名称 类型 描述 必选/可选 method 字符串 固定值;shares 必选 字符串 查看文件前要输人此值 可选 password A.3.9.5消息头附加域 无 A.3.9.6请求体参数 无 A.3.9.7响应参数 无 A.3.9.8响应消息体参数 创建分享的响应消息体参数见表A.34
表A.34创建分享的响应消息体参数 名称 类型 描述 必选/可选 字符串 分享文件的下载页面 必选 ur password 字符串 查看文件前要输人此值 可选 A.3.10获取分享列表 A.3.10.1功能描述 用户获取分享列表
A.3.10.2请求消息 请求消息见示例
示例: 请求消息 GET /? method=listsharesHTTP/1. Host:HostServer Date:date Authorization;signatureValue A.3.10.3请求参数 获取分享列表的请求参数见表A.35 28
GB/36623一2018 表A.35获取分享列表的请求参数 名称 类型 描述 必选/可选 字符串 method 固定值:listshares 必选 Mla 整型 该列表下最大的文件数目,超过时出错 可选 limit 和page_size一起使用,表示请求页数,从1开始,默认 整型 可选 page 值:0(表示不分页 整型 当page不等于0时有效,表示每页显示的文件内容大小可选 page_siz A.3.10.4消息头附加域 无 A.3.10.5 请求体参数 无 A.3.10.6响应参数 无 A.3.10.7响应消息体参数 获取分享列表的响应消息体参数见表A.36
表A.36获取分享列表的响应消息体参数 名称 类型 描述 必选/可选 字符串 分享文件(夹)的下载页面 必选 url path 字符串 分享文件(夹)的绝对路径 必选 创建分享文件(夹)的时间 shares_time 字符串 可选 它是一个数组,以JsOoN串的形式显示所获取到的分 享 hidren 数组 可选 文件或文件夹的具体信息 A.3.11获取分享文件 A.3.11.1功能描述 根据分享链接,获取分享文件的内容
A.3.11.2请求消息 请求消息见示例
示例 请求消息 GET/?method=downloadshare&.url=url8-password=passwordHTTP/1.l Host:HostServer Date:date 29
GB/T36623一2018 Authorization:signatureValue A.3.113请求参数 获取分享文件的请求参数见表A.37
表A.37获取分享文件的请求参数 类型 描述 名称 必选/可选 字符串 固定值.downloadshare 必选 method 字符串 分享文件的下载页面 必选 url 字符串 查看文件前要输人此值 可选 password A.3.11.4消息头附加域 无 A.3.11.5请求体参数 无 A.3.11.6响应参数 获取分享文件的响应参数见表A.38
表A.38获取分享文件的响应参数 名称 类型 描述 必选/可选 Content-MD5 字符串 对消息的内容作M5校验,防止数据中途损坏 可选 A.3.11.7响应消息体参数 无 A.3.12取消分享 A.3.12.1功能描述 删除一个文件(夹)的分享链接
A.3.12.2请求消息 请求消息见示例
示例: 请求消息: PUT
GB/36623一2018 A.3.12.3请求URL 请求URL见示例
示例 请求URL http;//bs.china.com/
GB/T36623一2018 示例: 请求URL http://fbs.china.com/
GB/36623一2018 示例 请求URL http;//s.china.com/
GB/T36623一2018 示例: 请求消息 GET
GB/36623一2018 附录 B 资料性附录 文件服务应用接口示例 B.1基本接口示例 B.1.1创建文件夹 B.1.1.1请求消息 请求消息见示例
示例 请求消息: PUT myFwlter method=mkadirHTTP/1.1 Host:fbs,china.com Dte;wed,12oct200917;50,00GMT Authortation;Fs15BD461F17824206A;xQEodiMhL.Repd6YB十FEXAMPLE- B.1.1.2响应消息 响应消息见示例 示例 响应消息: HTTP/1.1200ok Date:wed，12Oct200917:50;00GMT Content-Type:application/json Content-l.ength:153 Server:FBSFbsServer Connection:close "fs_id" "5338850315", "path";"/myFolder" "ereate_time";"wed，12Oet200917:50:00GMT" "wed,12Oet200917,50,;00GMT" "modily_time";: B.1.2获取文件列表 B.1.2.1请求消息 请求消息见示例
示例 请求消息: GET/MyPieture?method=listHTTP/1.1l Host:fbs.china.com GMT Date;wed,25Nov200912;00,00 35
GB/T36623一2018 Authorization:O1BSKHGF568HJG254LUTRE65;kljgogbas十=ao9872bgvsfoijGHT B.1.2.2响应消息 响应消息见示例
示例 响应消息: HTTP/1.1200OK Date:wed,01Mar200912;00,00GMT Content-Type:applieation/json Content-Length:214 Server:FBSServer "children" "fs_id”;"577791696897" "isdir""alse" "path""NMyPieture/est.jpg" 'size""50bytes" "Sun， 200620;00;00GMT" 、 "create_time"; Jan "modify_timme";"Sun,1Jan200620;00;00GMT" "MD5";"balf251lfc30423bdbbl83fe33f3ddof" B.1.3上传文件 B.1.3.1请求消息 请求消息见示例
示例 请求消息: PUT HTTP/1.l myfRolder/mylmage.jpe?" method=upload Host:ts.china.conm Date:wed，12Oet200917;50:00GMT AuthorizationFEs15BHD8461lF177624206A;xQEodiMDL.Repd3YB十FEXAMPLE- Contemt-Type;image/ipg Content-l.ength:ll434 [434bytes.fledata B.1.3.2响应消息 响应消息见示例
示例 响应消息 HTTP/1.1200ok wed，12cet t200917;50,00GMT Date 36
GB/36623一2018 Content-Type:application/jsonm Content-l.ength:153 ServerFBSFbsServer Connection:close f_id";"4738850315", "fs "path""/myFolder/mylm1 age.jPg" "size""ll434bytes" "ereate_time";"wed，12Oct200917:50:00GMT" "modiyTime";"wed，12oct200917;50;00GMTr" B.1.4下载文件(夹 B.1.4.1请求消息 请求消息见示例
示例 请求消息 GET/example/test.jpg?method=downloadHTTP/1.1 Host:fbs.china.com Date:wed，12Oct200917;50;00GMT Authorization:FBS15B4D3461F177624206A;xQEodiMbLRepdf3YB十FIEXAMPILE- B.1.4.2响应消息 响应消息见示例
示例 响应消息 HTTP/1.1200(OK tMnx"bal251te30423batbl83ls336dior" Content- Server:FBSServer conneection;cose Content-Type:image/jpg Content-lL.ength:1024 Date:wed，12Oct200917;50;00(GMT [1024bytesoffiledata B.1.5复制文件夹 B.1.5.1请求消息 请求消息见示例
示例 请求消息: PUT/myFolder/mylmage.jpg?method=copy&.from=/myFolder/test.jpgHTTP/1.l Hot fbs.china.com 37
GB/T36623一2018 Date;wed，12Oct200917;50:00GMT Athorizaton;FBs15BHD346IF177624206.A;xQEodiMbL.Repdf3YB十FIExAMPLE- B.1.5.2响应消息 响应消息见示例
示例: 响应消息 HTTP/1.1200ok Datewed，12Oet200917:50.:00GMT FESFbServer Server Content-Type:applieation/json Content-l.ength;53 Connection:close "s_id"，"4738850316" "from" /myFoder/test.jpg" "path”:"/myFolder/mylmage.jpg" B.1.6移动文件(夹 B.1.6.1请求消息 请求消息见示例
示例 请求消息 PUT/myFolder/mylmage.,jpg?method=move8.from=/myFolder/test.jpgHTTP/1.l Host:fbs.china.com Date:wed，12Oct200917:50:00GMT Authorization:FBS15B4D346IF177624206A:xQE0diMbLRepd3YB+FIEXAMPLE= B.1.6.2响应消息 响应消息见示例 示例: 响应消息" HTTP/1.1200ok Date:Wed，12(Oet200917;50:00GMT Server:FSFbsServer Conneetion;cose "fs_id”;"4738850316" "from";"/myFolder/test.jpg" "/myFolder/mylmage.jpg" "path" 38
GB/36623一2018 B.1.7删除文件(夹 B.1.7.1请求消息 请求消息见示例
示例 请求消息: method=deleteHTTP/1.l PUT/myFolder/mylmagejpg?me Host:fbs,china.com Date:Wed，12Oet200917:50;00GMT Authorization:FBS15B4D3461F177624206A:xQE0diMbLRepdf3YB十FIEXAMPLE= B.1.7.2响应消息 响应消息见示例
示例 响应消息 HTTP/1.1200ok Datewed，12oct 00GMT 2oe17.0,ou Server:FBSFbsServer Connection:close Content-l.ength:0 B.2增强接口示例 B.2.1获取回收站列表 B.2.1.1请求消息 请求消息见示例
示例 请求消息 GET/?method=listrecycleHTTP/1.l Host:;fbs.china.com Date:Wed，25Nov200912;00;00GMT Authorization oEsKHGF568HG254lUTRE65;kljgogbas十=o9872bgvsfoiGHT B.2.1.2响应消息 响应消息见示例
示例: 响应消息 HTTP/1.1200OK Date:wed，01Mar200912;00;00GMT Content-Type:application/json Content-l.ength:214 FBSServer Server "children"[ 39
GB/T36623一2018 "577791696897" "长_id" "is_dir";"false" "path""/MyPiet icture/test.jpg" 'siz""50bytes" "Sun，1Jan200620;00;00GMT" createtime" "modify_time";"Sun，1Jan200620;00;00GMT" "MD5";"balf251lfc30423bdbb183fe33f3ddof" B.2.2还原文件(夹 B.2.2.1 请求消息 请求消息见示例
示例: 请求消息 PUT/?method=restore&.fs_id=577791696897HTTP/1.l Host:bs.china.com Date:Wed，12Oet200917;50;00GMT Authorization:FBS15B4D3461F177624206A;xQE0diMbLRepd3YB十FIEXAMPLE- "children" "fs_id”;"577791696897" B.2.2.2响应消息 明应消息见示倒
示例: 响应消息 HrTP/1.1200olk Date:wed，12Oet200917;50:00GMT Content-length;0 Server:FBSFbsServer Connection:close "cehildren": "fs_id”;"577791696897" "path";"/MyPeture/est,jpg" 40
GB/36623一2018 B.2.3彻底删除文件(夹) B.2.3.1请求消息 请求消息见示例
示例 请求消息 PUT /?method=ddeteHTTP/1.1 Host:fbs,ehina.com Dte;wed,12oct200917;50,00GMT Authorization:FBS15B4D3461F177624206A:xQE0diMbLRepdf3YB十FIEXAMPLE= Content-Type:applieation/jsonm Content-I.ength:57 "ehildren": "s_id";"577791696897" B.2.3.2响应消息 响应消息见示例 示例: 响应消息: HTTP/1.1200ok Date;wed，12Oct200917;50;00GMT Server:FBSFbsServer Connection:close B.2.4批量复制文件(夹) B.2.4.1请求消息 请求消息见示例
示例 请求消息: PUT/?method=copyHTTP/1.1 Host:bs.china.com Date:wed，12Oct200917:50;00GMT Repd3yB十HExAMLE- Authorization:FBS15BD3461F177624206A:xQE0dMbLRe Content-Type:applieation/jsonm Content-l.ength:5？ 41
GB/T36623一2018 "bateh";[ "fronm";"/apps/album/a/D/e","to";"/apps/album/D/b/e"), "from" /albunm/a/b/d","to";"/a apps/album/b/b/d"" "/Aw/" B.2.4.2响应消息 响应消息见示例
示例 响应消息
HT'TP/11200ok GMT Date:wed，12Oet200917;50;00！ Server;FBSFbsServer Connection:close Content-Type;applieation/jsonm Content-l.ength:57 "children":L "fs_id";"433791697421" "fs_idl""533791697421" B.2.5批量移动文件(夹 B.2.5.1请求消息 请求消息见示例
示例: 请求消息 PUT/？nmethod=moveHTTP/1.l Host:fbs.china.com GMT Date:Wwed，12(Oet200917;50;00！ Authorization:FBS15BH4D3461F177624206A;xQE0diMbLRepdf3YB+FIEXAMPLE= ContentType:applieation/jsonm Content-I.ength:57 "bateh":C "rom";"/apps/album/a/b/e","to";"/apps/allbum/b/b/c")
GB/36623一2018 ("from"”/aps:/allum/a(/b/","o","/ap:/alwm/b/b/e" B.2.5.2响应消息 响应消息见示例
示例 响应消息: HTTP/1.1200ok Date;wed，12Oct200917;50;00GMT Server，FBsFhsSerer Conneetion;close "hildren" "fs_id";"433791697421" "fs_id";"533791697421" B.2.6批量删除文件(夹 B.2.6.1请求消息 请求消息见示例
示例" 请求消息 PUT/?method=deleteHTTP/1.1 Host:bs.china.com ate;wed,12Oet200917;50,00GMT Authorization:FBS15B4D3461F177624206A;xQEodiMDLRepdf3YB+FIEXAMPLE- Content-Type:applieation/json Content-length:57 "batch":[ I"path";"/apps/album/a/Db/e" "path"”"appw/album/a//4" B.2.6.2响应消息 响应消息见示例
示例: 响应消息: HTTP/1.1200ok Dte;wed,12oct200917;50,00GMT 43
GB/T36623一2018 Server:FBSFbsServer Connection:close B.2.7 批量下载文件(夹 B.2.7.1请求消息 请求消息见示例
示例 请求消息" PUT/?method=downloadHTTP/1.1 Host:fts.china.com Date:wed.12Oct200917;50:00GMT Authorization，Fs15BHD3461F177624206A;xQEodiMbLRepd3YBFIEXAMPLE- Content-Type;applieation/json Content-I.ength:57 "batch" "path";"/apps/album/a/b/" "path";"/apps/album/a/b/d"y B.2.7.2响应消息 响应消息见示例 示例 响应消息: HTTP/1.1200ok Date:wed，12Oct200917;50;00GMT FBSFbsServer Server; Conneetion:close B.2.8搜索 B.2.8.1请求消息 请求消息见示例
示例 请求消息: GET/MyPieture?tmethod=search&.keyword=test HTTP/1.1 Hostfbs.china.com GMT Date:Wwed，25Nov200912;00;00 AuthorizationOBSKHGF568HJG254LUTRE65;kljgogbas十=ao9872bgvsfoijGHT B.2.8.2响应消息 响应消息见示例
示例: 响应消息: HTIP/1.1200OK GMT wed,01Mar200912;00,00 Date 44
GB/36623一2018 Content-Type:application/jsonm Content-l.ength:214 Server:FBSServer "ehildren" "fs_id”;"577791696897" "is_dir";"false" path" "MtPieture/testjpx" 'size";"50bytes" "Sun，1Jan200620;00;00GMT" create_time" 1200620,00;00(GMT" "Sun，1Jan modify_time" "MD5";"balf251lfc30423bdbb183fe33f3ddof" B.2.9创建分享 B.2.9.1请求消息 请求消息见示例 示例 请求消息: PUT/myFolder/mylmage.jpg?method=shares&password=123HTTP/1.1 Host:fbs.ehina.com Dte;wed,12oct200917;50,00GMT Authorization:FBS15B4D3461F177624206A;xQE0diMbLRepdf3YB+FIEXAMPLE= B.2.9.2响应消息 响应消息见示例
示例: 响应消息 HTTP/1.1200ok Date:Wed，12(Oct200917:50:00GMT Content-Type:applieation/jsonm 57 Content-Length: Server:FBSFbsServer Conneetion;close /cOmFuulY" 'url";"https://fbs.china.com/ "password":"123" B.2.10获取分享文件 B.2.10.1请求消息 请求消息见示例 45
GB/T36623一2018 示例: 请求消息 GET/?method=downloadshare&ul=htps;/Bs.china.com/eOmFualY&password,123HTTPy1.1 Host:bs.china.com Date:Wwed，12Oet200917;50;00GMT Rpd6YB十HExAMPLE- Authorization:FEBS15B4D3461F177624206A;xQE0diMbLR B.2.10.2响应消息 响应消息见示例
示例 响应消息 HTTP/1.1200OK Content-MD5;"balf251lfe30423bdbl83fe333ddof" Server:FSServer Connection:close Content-Type:image/jpg Content-length:1024 Date:wed，12Oct200917;50:00GMT 1024bytesoffledata] B.2.11获取分享列表 B.2.11.1请求消息 请求消息见示例
示例: 请求消息 PUT/?nmethod=listsharesHTTP/1.1 Host:fbs.china.com Dte;wed,12Oet200917;50,00GMT Authorization:FBS15B4D3461F177624206A;xQE0diMbLRepdf3YB十FIEXAMPLE- B.2.11.2响应消息 响应消息见示例
示例 响应消息: HTTP/1.1200ok Date:wed，12(Oet200917;50:00GMT ContentType:applieation/jsonm Content-length:100 FBSFbsServer Connection:close "ehildren" "url""https;//bs.chma.com/cOmFuwlY" 46
GB/36623一2018 "MsPetuwrv/etjw" "path" "shares_time";"Sun，1Jan200620;00;00GMT" B.2.12取消分享 B.2.12.1请求消息 请求消息见示例
示例 请求消息: PUT//MyPietwre/test.jpg”method=ceanelsharesHTP/A.l Host:fbs,china.com Date;wed，12Oct200917;50;00GMT Authorization:FBs15B4D3461F177624206A;xQEodiMhL.Repd3YB+FIEXAMPLE- B.2.12.2响应消息 响应消息见示例
示例: 响应消息 HTTP/1.1200ok Date:Wed，12Oct200919;50;00GMT Content-l.ength;0 Server:FBSFbsServer Connection:cose B.2.13获取图片文件缩略图 B.2.13.1请求消息 请求消息见示例
示例 请求消息: GET =328.width=32 /example/test.jpg?method=thumbnail&h HTTP/1. -height一 Host:bs.china.com Date:Wed，12Oct200917;50:00GMT Athorization;FBs15B4D346IF177624206A;xQEodiMbLRepd3YB十FIEXAMPLE- B.2.13.2响应消息 响应消息见示例
示例: 响应消息 HTTP/1.1200OK Server:FBSServer Connection:close 47
GB/T36623一2018 Content-Type image/jPg Content-l.ength;1024 Date;wed,12Oet200917;50.00GMT [1024bytesofiledata B.2.14查看历史版本 B.2.14.1请求消息 请求消息见示例
示例 请求消息
GET/MyPieture/test.jpg?method=listversionHTTP/1.1 Host:fbs.china.com GMT DateWed，25Nov2009 12.0.0on OosKIHGF8HHG25l.UTREB865,iedhas十=w872hgoshboirGHr Authorization: B.2.14.2响应消息 响应消息见示例
示例 响应消息" HTTP/1.1200OK Date:Wed,01Mar200912;00;00GMT Content-Type:appliecation/json 214 Content-Iength: Server:FBSServer "children":D "5" "version_id" "path";"/MyPieture/test.jpg", "50bytes" size "Sun，1Jan200620;00;00GMT' create_time" "modify_time":"Sun，1Jan200620:00:00GMT" B.2.15恢复文件 B.2.15.1请求消息 请求消息见示例
示例 请求消息: GET/MyPieture/test.jpg?method=restoreversion&.version_id=5HTTP/1. Host;fbs.china.com 48
GB/36623一2018 Date;Wed，25Nov200912;00;00GMT Authorization:OBSKHGF568HJG254LUTRE65;kjgogbas十=ao9872bgvsfoijGHT B.2.15.2响应消息 响应消息见示例
示例: 响应消息 HTTP/1.1200OK GMT Date:wed.01Mar200912;00;00 Content-Type:applieation/json Content-I.ength:214 Server:FBSServer "version_id”;"5" "MtPieture/testjpx" "path"; "size";"50bytes" 'create_time":"Sun1Jan200620:00:00GMT" 200620 GMT" "modify_time";"Su "Sun，1Jan .00;00
GB/T36623-2018：信息技术云计算文件服务应用接口
随着云计算技术的普及，越来越多的企业和个人选择将数据存储到云端。而云计算文件服务作为云计算的一项重要应用，也是近年来发展最快的领域之一。为了规范云计算文件服务，提高其安全性和互操作性，国家质量监督检验检疫总局、中国国家标准化管理委员会于2018年发布了《信息技术云计算文件服务应用接口》（GB/T36623-2018）。 该标准主要针对云计算文件服务应用接口进行规范，以确保不同厂商的云计算文件服务能够实现互通和互操作。具体规定如下： 1. 接口基本要求 （1）符合云计算的安全、可靠、高效、灵活等特点； （2）支持文件上传、下载、重命名、删除等基本操作； （3）支持目录操作、分享和协作等高级功能； （4）支持标准化的API接口，以便于二次开发和集成。 2. 接口安全要求 （1）采用HTTPS协议传输数据； （2）对用户的身份进行认证和授权； （3）对数据进行加密存储和传输； （4）日志审计和异常处理。 3. 接口性能要求 （1）支持大文件上传和高并发访问； （2）支持文件断点续传和秒传； （3）支持文件快速检索和定位。 总的来说，GB/T36623-2018标准的发布，为云计算文件服务提供了规范化的应用接口，有利于推动云计算技术的进一步发展。各云计算服务厂商应当根据标准要求实现云计算文件服务应用接口，并加强对接口的管理和监控，以确保用户数据的安全和可靠性。
