GB/T31916.3-2018
信息技术云数据存储和管理第3部分：分布式文件存储应用接口
Informationtechnology—Clouddatastorageandmanagement—Part3:Distributedfilestorageapplicationinterface
- 中国标准分类号（CCS）L79
- 国际标准分类号（ICS）35.100.05
- 实施日期2019-01-01
- 文件格式PDF
- 文本页数111页
- 文件大小5.66M
以图片形式预览信息技术云数据存储和管理第3部分：分布式文件存储应用接口
信息技术云数据存储和管理第3部分：分布式文件存储应用接口
国家标准 GB/31916.3一2018 信息技术云数据存储和管理 第3部分:分布式文件存储应用接口 nformationtechnology一Couddatastorageandmanagement Part3:Distributedlfilestorageapplieationinterface 2018-06-07发布 2019-01-01实施 国家市场监督管理总局 发布 国家标准化管理委员会国家标准
GB;/T31916.3一2018 目 次 前言 范围 2 符合性 规范性引用文件 术语、定义和缩略语 4.1术语和定义 4.2缩略语 分布式文件存储接口定位和系统结构 5.1分布式文件存储接口定位 5.2分布式文件存储系统结构 应用接口通用要求 6.I概述 6.2命名规则 6.3补充出错信息 公共请求头 6,.4 .5公共响应头 文件接口要求 7.1概述 7.2 创建文件 7. 删除文件 7.4 上传文件 下载文件 7.5 ll 7.0 13 追加写文件 7. 复制文件 16 重命名文件 18 7.8 7.9 查看文件状态 20 22 .10修改文件属性 7.I文件搜索 24 7.12读文件 6 7.13写文件 28 30 文件夹接口要求 8.1概述 30 8.2创建文件夹 31 8.3删除文件夹 38 8.4上传文件夹 35 8.5下载文件夹 37 39 8.6复制文件夹
GB/T31916.3一2018 8.7重命名文件夹 4 43 8.8查看文件夹状态 8.9修改文件夹属性 45 t7 8.10文件夹搜索 49 8.11列出文件夹内容 回收站接口要求 5 51 9.1概述 9.2还原回收站文件 9.3查询回收站文件 5 9.4彻底删除回收站文件 9.5清空回收站 590 9.6 全部还原 扩展属性接口要求 10 60 60 0.I概述 61 10.2设置扩展属性 删除扩展属性 10,3 63 64 读取扩展属性 10,4 0.5列出扩展属性 11 快照接口要求 69 69 ll.1概述 1.2创建快照 69 77 1.3删除快照 1.！列出快照 5 1.5重命名快照 12 访问控制列表接口要求 7n 77 12.1概述 77 12.2添加ACI
规则 79 12.3读取ACL 882 12.4修改ACI
规则 12.5删除ACL
84 12.6删除ACL规则 86 12.7删除默认ACL
规则 887 附录A(规范性附录分布式文件存储管理接口 90 106 附录B(规范性附录补充出错信息
GB;/T31916.3一2018 前 言 GB/T31916《信息技术云数据存储和管理》分为六个部分 第1部分:总则 -第2部分:基于对象的云存储应用接口; 第3部分:分布式文件存储应用接口; 第4部分;基于块的云存储应用接口; 第5部分:基于键值(Key-Value)的云数据管理应用接口; 第6部分;分布式关系数据库应用接口
本部分为GB/T31916的第3部分
本部分按照GB/T1.1一2009给出的规则起草
本部分由全国信息技术标准化技术委员会(SAC/TC28)提出并归口
本部分起草单位:上海计算机软件技术开发中心、电子技术标准化研究院、浪潮(北京)电子信 息产业有限公司、华为技术有限公司、华中科技大学、,阿里云计算有限公司、科学院深圳先进技术研 究院、深圳赛西信息技术有限公司 本部分主要起草人:蔡立志、陈志峰,陈文捷、颜秉璀、胡芸,王志鹏,吴涛、杨丽蕴,王洁萍,周景才、 刘振宇、赵江、周可、喻之斌、贝振东、易晶晶、王学英
GB;/T31916.3一2018 信息技术云数据存储和管理 第3部分:分布式文件存储应用接口 范围 GB/T31916的本部分给出了分布式文件存储的体系结构,规定了分布式文件存储的应用接口通 用要求和应用接口
本部分适用于分布式文件存储的设计、开发、测试和使用
2 符合性 本部分所定义的接口分为必选项和可选项,其中文件接口、文件夹接口和回收站接口为必选接口， 其他接口为可选接口,每一个接口命令的参数可能包含必选参数和可选参数
符合性包含以下几种 情况 -个系统实现了所有的接口包含必选接口和可选接口),可声称为完全符合本部分 a b -个系统实现了所有的必选接口,可声称为符合本部分
个系统没有完全实现所有的必选接口,则不符合本部分 规范性引用文件 下列文件对于本文件的应用是必不可少的
凡是注日期的引用文件,仅注日期的版本适用于本文 件
凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件
数据元和交换格式信息交换日期和时间表示法 GB/T74082005 GB/T31916.1一2015 信息技术云数据存储和管理第1部分总则 RFC822ARPA互联网文本消息格式标准(StandardfortheFormatofARPAIntermetText Messages RFc2616超文本传输协议(HTTP)1.1(HypertextTransferProtocolHTTP/1.1) RFc7159JavaSeript对象标记(JsON)数据交换格式[TheJavaSeriptObjectNotation(JsON) DatalnterchangeFormat 术语定义和缩略语 4.1术语和定义 GB/T31916.1一2015界定的以及下列术语和定义适用于本文件
4.1.1 分布式文件存储distributelfilesystcemm -种作为应用安装在操作系统之上的文件系统,其存储资源分布在不同的计算机节点上,并通过计 算机网络相连
GB/T31916.3一2018 4.2缩略语 下列缩略语适用于本文件
ACL ccessControlList 访问控制列表(Acc HTTP 超文本传输协议(HypertextTransferProtocol) JSON JavasSeript对象标记法JavaSeriptObjeetNotation) UR 统一资源定位符(UniformResourceI.ocator) 5 分布式文件存储接口定位和系统结构 5.1分布式文件存储接口定位 应用层的分布式文件存储接口的定位如图1所示
从操作系统的视角看,应用层分布式文件存储 作为一个传统操作系统的应用,不涉及操作系统内核相关的操作,进免了分布式文件存储对于操作系统 的依赖和约束
同时,应用层分布式文件存储提供了各类接口,其中文件接口,文件夹接口,回收站接 口、扩展属性接口,快照接口、ACI接口为上层的各类应用系统提供必要的功能支撑
除应用接口外 分布式文什存储也提供一些管理功能的接口供管理员使用,见附录A 应用系统1 应用系统1 应用系统1 系统管理员 应用层 HTIP接口 应用接口 文件接口 文件夹接口 回收站接口 扩展属性接口 快照接口 ACL接口 管理接口 分布式文件 存储层 监控 元数据 数据存储 数据存储 数据存储 服务器 服务器 服务器 服务器 服务器 文件系统 文件系统 文件系统 文件系统 文件系统 物理层 OS OS OS OS OS 图1分布式文件存储接口定位 5.2分布式文件存储系统结构 分布式文件存储的系统结构包括;元数据服务器、数据存储服务器、监控服务器和客户端
图2展 示了这种分布式文件存储的一般体系结构
GB;/T31916.3一2018 元数据服务器 客户端 管理接口 管理员 数据映射 应用接口 元数据访问 数据存储 数据存储 数据存储 服务器 服务器 服务器 数据访间 监控服务器 图2分布式文件存储的一般体系结构 元数据服务器;提供整个文件系统的目录信息,并且管理各个存储服务器,是整个文件系统的核心 元数据服务器维护着一张表,其中记录了文件系统中所有的文件名与该文件存储地址的对应关系
元 数据服务器还有管理各个存储服务器的功能
元数据服务器可以有一个或多个 数据存储服务器;用于存放实际的文件数据
所有的分布式文件存储都需要有至少一个存储服务 器
客户端查询到某个文件的实际存放地址后就直接和存储服务器通信以获取文件
监控服务器;提供整个分布式文件存储的服务监控、日志记录等管理功能,可为整个服务运行提供 管理支持
在某些分布式文件存储中监控服务器的功能整合到了元数据服务器中
客户端:使用分布式文件存储来存储和访问的主机称为分布式文件存储的客户端,成功连接文件系 统以后,就可以通过应用接口对文件系统进行操作
应用接口通用要求 6.1概述 分布式文件存储应用接口通用要求包括接口协议、身份安全管理、命名规则状态码信息描述、补充 出错信息、公共请求头、公共响应头和出错信息描述要求8项内容
其中接口协议、身份安全管理、状 态码信息描述和出错信息描述要求4项内容见GB/T31916.1一2015中相应部分
6.2命名规则 所有文件、文件夹、路径的命名规则如下 名称可用字母、数字、下划线(_),短横线(-)和中文字符
名称应以字母、数字或者中文字符开头
名称最长可允许256个字符
所有响应中需要命名的部分见RFC7159
6.3补充出错信息 分布式文件存储发生的出错响应较为复杂,需要对HTTP状态码补充出错信息描述
出错信息格 式符合GB/T31916.1一2015中5,4的要求
补充出错信息描述见附录B
GB/T31916.3一2018 6.4公共请求头 公共请求头应包括信息见表1(见RFC2616)
表1公共请求头信息 名称 描述 选择状态 Host 主机信息,如:example.distfs.cn 必选 Accept application/json 可选 可选 Content-Type application/json或 Authorization 用户授权信息 必选 6.5公共响应头 公共响应头应包括信息见表2
表2公共响应头信息 名称 描述 选择状态 取决响应消息内容,对于有内容的响应,本参 响应消息内容长度(不含消息头) Content-length 数必选;无内容的响应,可选 Content-Type 表示响应文档属于什么MIME类型 可选 消息响应的时间,时间的描述格式由RFC 822定义，如:Sun，18Nov200606: Date 必选 D0GMT 12;00 Server 处理请求的原始服务器的信息 可选 文件接口要求 7.1概述 分布式文件存储的文件接口是对系统中的文件进行操作的接口,包括创建文件、删除文件、上传文 件、下载文件,追加写文件、复制文件、重命名文件、查看文件状态、修改文件属性,文件搜索、读文件和写 文件
文件接口是必选接口 7.2创建文件 7.2.1功能描述 创建文件的操作参数为:CreateFile,用于在分布式文件存储中创建文件
创建的文件名应在文件 夹中唯- 7.2.2请求定义 op=createfile8.name=xxx[&.overwrite=true PUT/Aceount)/Path)？ ue/false][&1 permisSion= sx][&.replication=(short)][&.trashime= =<(time)HTTP/1. XxX
GB;/T31916.3一2018 Host:[HostName] Accept:application/json Content-Type:application/json Authorization:[SignatureValue 7.2.3请求URL http://example.distfs.cn/《Account>/(Path) 其中:(Account)表示账户ID,(Path)表示创建文件的位置
7.2.4请求消息头 按公共请求头定义
7.2.5请求消息参数 请求消息参数见表3
表3请求消息参数 类型 参数 名称 描述 选择状态 文件名称 文件名称应符合6.2中所述的文件命各规则 必选 name String 文件重名覆盖 Boolean lrue表示可覆盖,alse表示不允许覆盖,默认值为false 可选 oVerwrlte 标记 permission r表示可读,w表示可写,x表示可执行,默认值为rwx 文件权限 String 可选 512之间的正整数,应大于或等于系统最低文件副 0 replieation 副本数 Short 可选 本数,默认值为系统最低文件副本数 正整数十单位,格式如12min
单位包括秒s)、分 回收站保存时间 ,小时(h),天(d,月(M)
最大值为24个月
默 可选 trashtime min String 认值为1天 7.2.6请求消息体 7.2.7响应状态码 响应状态码及其描述见表4
表4响应状态码 状态码 描述 200 OK,创建成功 400 InvalidFileName,文件名不符合命名规则 nvwalidFilePermission,文件权限参数不正确 400
GB/T31916.3一2018 表4续) 状态码 描述 nvalidFileSize,用户请求创建文件大小大于系统设定的最大文件大小值 400 lnvalidReplicationNumber， 用户请求修改的文件副本数目不是0一512之间的正整数或小于系统最低文件 400 副本数 400 nvalidTrnshTime,文件保存时间不符合格式或超过24个月 401 Unauthorized ed,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有创建文件的权限 404 NoSuchFolder,用户请求的文件路径不存在 409 FileAlreadyExists,用户创建的文件名与已有文件重名,并且重名覆盖标记为false NotImplementcd,服务器不支持此功能接口 501 7.2.8响应定义 HTTP/1.1200OK Date:date Content-Type:application/json C， Content-Iength:length Server:server "ctime':"xxxXxxxxx 7.2.9响应消息头 按公共响应头定义
7.2.10响应消息体 响应消息体中各参数描述见表5
表5响应消息体 参数 名称 选择状态 类型 描述 ctime文件的创建时间戳 string时间的格式由GB/T7408一2005定义,如:2006-l1-18To6:12;00 必选 7.2.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 PUT =cerceatefile&.name=temp.txt 7MyAccount/temp?op一 &.overwrite=true&permission=rwx&.replication=5&.trashtime=12MHTTP/1. Host:example.distfs.cn
GB;/T31916.3一2018 Accept:application/json Content aTe application/json Athorization;15UYRRTY876oU4D 响应消息: HTTP/1.1200OK Datesun，6Feb201118;10,00GMT Content-Type:applieation/jsonm content-length:length Serverexample.distfs.cn "ctime";"2006-l1-18TO6:l2;00" 7.3删除文件 7.3.1功能描述 删除文件的操作参数为;DeeteFile.,用于删除文件
删除文件时系统应将之放人回收站
7.3.2请求定义 DELETE/Account)/(Path)?op=deleteffle&.name=xxx[&.trashtime=(time>]HTTP/1. Host:[HostNa Name Accept:applieation/json Content- Type，aplhetiom/jon reValue Authorizat aion.[Signadur 7.3.3请求URL ://example.distfs,cn/Account)/Path》/ http: 其中:Account)表示账户ID,(Path)表示文件的位置
7.3.4请求消息头 按公共请求头定义
7.3.5请求消息参数 请求消息参数见表6
表6请求消息参数 参数 名称 类型 描述 选择状态 name 文件名称 文件名称应符合6.2中所述的文件命名规则 string 必选 正整数十单位,格式如12min
单位包括秒s),分 trashtime 回收站保存时间 mim),小时(h),天(d),月(M)
最大值为24个月
默 可选 string 认值为文件原来的trashtime 7.3.6请求消息体 无
GB/T31916.3一2018 7.3.7响应状态码 响应状态码及其描述见表7
表7响应状态码 状态码 描述 200 OK,删除成功 400 InvalidFileName,用户请求的文件名称或位置不符合命名规则 InvalidTrashTime,文件保存时间不符合格式或超过24个月 400 Unauthorized,用户没有传人验证信息或验证信息不正确 401 403 Forbhidden,用户没有制除文件的权限 NwSthFil,用户请求的文件不存在 404 Not 501 lmplemented,服务器不支持此功能接口 7.3.8响应定义 HTTP/1.1200OK Date:date Content-Type:application/json Server:server 7.3.9响应消息头 按公共响应头定义
7.3.10响应消息体 无
7.3.11请求和响应示例 请求消息和响应消息见示例
示例" 请求消息 DELETE/MyAccount/temp?op=deletefile&.name=tmp HT'TP/1.1 eampe.disscn Host Accept:appliceation/json Content-Type;applieation/jsonm Authorization:l51UYRRTY876OIU4D 响应消息: HTTP/1.1200(OK Date:Sun，6Feb201118;10;00GMT Content-Type:applieation/jsonm Server;example.distfs.,cn
GB;/T31916.3一2018 7.4上传文件 7.4.1功能描述 上传文件的操作参数为;UploadFile,用于上传本地的文件到分布式文件存储
7.4.2请求定义 ission= PUT/Account)/(Path)?op=uploadfile&[&.o =0l1|2][&perm =xxx verwrite [[&.replieation=(short)][&.trashtime=(time>]HTTP/1.1 Host:[HostName] Accept:application/json Content-Type:application/json Authorization:[SignatureVale "localfilepath";"xxxxxx" 7.4.3请求URL http://example.distfs.cn/(AG ccount)/Path)/ 其中:〈Account)表示账户ID,(Path)表示上传到的文件夹的位置
7.4.4请求消息头 按公共请求头定义
7.4.5请求消息参数 请求消息参数见表8 表8请求消息参数 参数 名称 类型 描述 选择状态 文 件重名覆盖 0表示可覆盖，1表示不允许覆盖,2表示自动重命名为 可选 overwrite nt |FileName1,FileName2以此类推
默认值为1 标记 permission 文件火权限 r表示可读,w表示 可写,x表示可执行,默认值为rwx 可选 sstring -512之间的正整数,应大于或等于系统最低文件副 replieation short 副本数 可选 本数,默认值为系统最低文件副本数 正整数十单位,格式如12min
单位包括秒s),分 回收站保存时间 min),小时(h),天(d,月(M)
最大值为6个月
默 可选 trashtime string 认值为1天 7.4.6请求消息体 请求消息体中各参数描述见表9
GB/T31916.3一2018 表9请求消息体 参数 名称 类型 描述 选择状态 localilepath本地文件位置 string 文件名称应符合6.2中所述的文件命名规则 必选 7.4.7响应状态码 响应状态码及其描述见表10. 表10响应状态码 状态码 描述 200 OK.上传成功 400 nvalidFileName,文件名称不符合命名规则 400 InvalidPermission,文件权限参数不正确 InvalidFileSize,用户请求上传的文件大于系统设定的最大文件大小值 400 ,用户请求的文件副本数目不是0-512之间的正整数或小于系统最低文件朗 lnvalidReplieationNumber, 400 本数 nvalidTrshTime,文件保存时间不符合格式或超过6个月 400 40l Unathorized,用户没有传人验证信息或验证信息不正确 Forbidden. ,用户没有在文件夹中创建文件的权限 403 404 NoSuchfFolder,用户请求的文件路径不存在 409 FileAIreadyE.xists,用户请求上传文件名与已有文件夹重名,并且重名覆盖标记为1 501 Notlmpemented,服务器不支持此功能接口 7.4.8响应定义 HTTP/1.1200OK Date:date Content-Type:applieation/js s0n Content-Iength:length Server:server "filepath XXXXxx ctime XxXXXXxXXXX 7.4.9响应消息头 按公共响应头定义 7.4.10响应消息体 响应消息体中各参数描述见表1l 10
GB;/T31916.3一2018 表11响应消息体 参数 名称 类型 描述 选择状态 上传位置 文件上传的位置 filepath sstring 必选 l时间的格式由GB/T74082005定义，如:2006-11 必选 文件创建时间截 ctime string 18To6:12:00 7.4.11 请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 PUT /MyAecount/temp?op=uploadile&.overwrite=28.permission=rwx&.replication=5&.trashtime=12M HTTP/1.1 Host:example.distfs.cn AAceept:applieation/json Type:application/json Authorization,15IUYRRTY876OIU4D 'localfile";"C;\myfolder\myfile.txt" 响应消息: HTTP/1.1200O)K GMT Date:Sun，6Feb201l118;l0;00 Content-Type:applieation/jsonm Content-Length:58 Server:example.distfs.cn "folderpath","MyAccount/ /emp/myfholder" "etime":"2006-11-18To6:12;00" 7.5下载文件 7.5.1功能描述 下载文件的操作参数为;DownloadFile,用于将文件从分布式文件存储下载到本地
7.5.2请求定义 GET/Aecount)/Path>?op=downloadfleHTTP/1.1 Host:[HostName] Accept:applieation/json cone-Type，plieatiom/jon" R Range:bytes=start)-(end Authorization:;[SignatureValue 11
GB/T31916.3一2018 "localpath” XxXXxX "aliasnamme XxxXxXx 7.5.3请求URL up:/esmpc.iets.csm/Acms>/Pah/ 其中:(Ac ccount t)表示账户ID,(Path)表示欲下载的文件的位置
7.5.4请求消息头 Range头为可选,其中的(start)表示传输文件的起始字节(end表示传输文件的结束字节,均以整 数表示
其余按公共请求头定义 7.5.5请求消息参数 无
7.5.6请求消息体 请求消息体中各参数描述见表12
表12请求消息体 参数 名称 类型 描述 选择状态 文件下载到本地 其名称应符合6.2中所述的文件命名规则 ocalpath tring 必选 后的位置 下载后文件的另 文件名称应符合6.2中所述的文件命名规则 aliasname string 可选 存名 7.5.7响应状态码 响应状态码及其描述见表13. 表13响应状态码 描述 状态码 200 OK,下载成功 206 PartialContent,下载部分文件内容成功 InvalidFleName,文件名称不符合命名规则 400 400 InvalidFolderName,用户指定的下载路径不符合命名规则 nvaldRange,用户指定的传输范围不在文件大小范围内 400 Unauthorized,用户没有传人验证信息或验证信息不正确 40l Forbidde den,用户没有读取文件的权限 403 404 NoSuehFile,用户请求的文件路径不存在 404 NoSuchFoder,用户本地路径不存在 501 NotImplemented,服务器不支持此功能接口 12
GB;/T31916.3一2018 7.5.8响应定义 HTTP/1.1200OK Dat hte:date Conent-Type，apleation/ octet-stream Content-L Lengtha" length Content-Range:bytesstart)》-end>/total Server:server bytesoffiledata 7.5.9响应消息头 Content-Range头为可选,其中(start)表示传输文件的起始字节,(end)表示传输文件的结束字节 total)表示文件总大小(单位为字节),均以整数表示
其余按公共响应头定义
7.5.10响应消息体 下载文件的内容
7.5.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 GET/MyAccount/emp/audio?op -downloadfleHTIP/1. Host:example.distfs.cn Aceept:application/json ContentType:application/json Range;bytes=0-10o Authorization:15IUYRRTY876OIU4D "oealpad""C\myfolduer" "lasname";"myfle.txt" 响应消息 HTTP/1.1206PartialContent Date;Sun，6Feb201118:10;00GMT Content-Type:application/octetstream Content-l.ength:100 Content-Range:bytes0-100/1231 Server;example.distfs.cn bytesofiledata 7.6追加写文件 7.6.1功能描述 追加写文件的操作参数为:AppendFile,用于在分布式文件存储中追加写文件
13
GB/T31916.3一2018 7.6.2请求定义 PUT/Account dfile&.name= nt)/(Path)?op=append =xxx[buffersize=(int)]HTTP/1.1 Host:[HostNamel Accept:applieation/json Content-Type:applieation/octetstream reValuue ;[Si;gdure Authorization: ofdata》 byte 7.6.3请求URL Htp://example.disfs.cm/Aeoum)/Pah/ 其中:(Ac nt)表示账户ID,(Path)表示文件的位置 ccount 7.6.4请求消息头 按公共请求头定义
7.6.5请求消息参数 请求消息参数见表14
表14请求消息参数 参数 名称 类型 描述 选择状态 文件名称 文件名称应符合6.2中所述的文件命名规则 name string 必选 buffersize 缓冲区大小 缓冲区的大小 可选 int 7.6.6请求消息体 追加写的数据
7.6.7响应状态码 响应状态码及其描述见表15
表15响应状态码 状态码 描述 200 OK,追加写成功 400 nvalidFileName,文件名不符合命名规则 400 nvalidFileSize,用户请求追加写后文件大于系统设定的最大文件大小值 401 Umauthorized,用户没有传人验证信息或验证信息不正确 Forbidden,用户没有追加写文件的权限 403 404 NoSuchFile,用户请求追加写的文件路径不存在 Notlmplemented,服务器不支持此功能接口 501 14
GB;/T31916.3一2018 7.6.8响应定义 HTTP/1.1200OK Date:date Content-Type;appication/json Content-length:length Server:server "ctime":"xxxxxxxx 7.6.9响应消息头 按公共响应头定义
7.6.10响应消息体 响应消息体中各参数描述见表16
表16响应消息体 类型 参数 名称 描述 选择状态 文件的创建时 l时间的格式由GB/T7408一2005定义，如:2006-1 ctime string 必选 18To6:12:00 间截 7.6.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 PUT/MyAcco ndfile&.name=templ.txt&.buffersize=4096HTTP/1.1 unt/temp?op=appen Host:example.distfs.cn AAccept:applieation/jsonm Content-Type:applieation/octet-stream Authorization:l15IUYRRTY876OU4D bytesofdata》 响应消息 HTTP/1.1200OK Dte;Sun,6Feb20l118;l0,00GMr Content-Type:application/json Content-length;31 Server:example,distfs.cn "etime";"2006-l1-18To6:12;00" 15
GB/T31916.3一2018 7.7复制文件 7.7.1功能描述 复制文件的操作参数为:CopyFile,用于在分布式文件存储中复制文件
7.7.2请求定义 )yfile[&.over PUT/Account>/(Path>?op=copy overwrite=0|1l2]HTTP/1.1 Host:[ostName Accept appliceation/json Content -Type:application/json Authorization:[SignatureValuue "destpath";"xxxxxx "aliasname" XXXXXX 7.7.3请求URL http://example,distfs.cn/Account>/Path》/ 其中;(Account)表示账户ID,(Path)表示欲复制的文件的位置
7.7.4请求消息头 按公共请求头定义
7.7.5请求消息参数 请求消息参数见表17
表17请求消息参数 参数 名称 类型 描述 选择状态 文件重名覆盖 0表示可覆盖,l表示不允许覆盖,2表示自动重命名为 可选 overwrite int 标记 lFileName-1,FileName-2以此类推
默认值为1 7.7.6请求消息体 请求消息体中各参数描述见表18. 表18请求消息体 参数 名称 类型 描述 选择状态 目标文件位置 其名称应符合6.2中所述的文件命名规则 必选 string destpath 复制后文件的新 文件名称应符合6.2中所述的文件命名规则 可选 aliasname string 文件名 16
GB;/T31916.3一2018 7.7.7响应状态码 响应状态码及其描述见表19. 表19响应状态码 状态码 描述 200 OK,复制成功 00 nvalidFileName,文件名称不符合命名规则 401 Unauthorized,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有在源文件夹中读取文件的权限 403 Forbidden,用户没有在目标文件夹中写的权限 NoSuehFile,用户请求的文件路径不存在 404 FHleAreadyExists,复制文件名或别名与已有文件重名,并且重名覆盖标记为！ 409 501 Notlmplemented,服务器不支持此功能接日 7.7.8响应定义 HTTP/1.1200OK Date:date ContentType，aplieation/jsonm Content-lLength:length Server:server "ctime XXXXXXX 7.7.9响应消息头 按公共响应头定义
7.7.10响应消息体 响应消息体中各参数描述见表20. 表20响应消息体 选择状态 参数 名称 类型 描述 文件的创建时间戳 string时间的格式由GB/T7408一2005定义,如;2006-1ln ctime I8T12.O 必选 7.7.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 PUT/MyAcount/emp/audio?op &overwrite=2HTTP/1.1 -epyilaccn 17
GB/T31916.3一2018 Host:example.distfs.cn Aecept:application/json Content-Type;applieation/jsonm Authorization;15IUYRRTY876OIU4D 'destpath";"/MyAceount/temp/music" 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118;:10:00GM门 Content-Type:application/json Content-l.ength;24 Server:example,distfs,en "ctime";"2006-l1-18To6:12:00" 7.8重命名文件 7.8.1功能描述 重命名文件的操作参数为;RenamneFile,用于在分布式文件存储中重命名文件
7.8.2请求定义 PUTAccount>/(Path)？op=renamefle[&.overwrite=0l1l2]HrTP/1.1 Host:[HostName Accept:application/json Content-Type:application/json Authorization:[SignatureValue "name";"xxxxxx" 7.8.3请求URI http://example.distfs.cn/Account)/Path) 其中:(Account)表示账户ID.(Path)表示欲重命名的文件的路径
7.8.4请求消息头 按公共请求头定义
7.8.5请求消息参数 请求消息参数见表21
表21请求消息参数 参数 名称 类型 描述 选择状态 l0表示可覆盖，1表示不允许覆盖，2表示自动重命名为 overwrite文件重名覆盖标记 int 可选 FileName-1 -1、FileName-2以此类推
默认值为1 18
GB;/T31916.3一2018 7.8.6请求消息体 请求消息体中各参数描述见表22
表22请求消息体 参数 名称 类型 描述 选择状态 文件的新名称 文件名称应符合6.2中所述的文件命名规则 name string 必选 7.8.7响应状态码 响应状态码及其描述见表23
表23响应状态码 状态码 描述 200 OK,重命名成功 nvwalidFileNanme,文件名称不符合命名规则 400 401 Umathorized,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有修改文件的权限 404 NoSuehFle,用户请求的文件路径不存在 09 FileAlreadyExists,文件新名与已有文件重名,并且重名覆盖标记为1 Notlmplemented,服务器不支持此功能接口 501 7.8.8响应定义 HTTP/1.1200oK Date:date Content-Type:application/json Server:server 7.8.9响应消息头 按公共响应头定义
7.8.10 响应消息体 无
7.8.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 renamefile&.overwrite- PUT/MyAcount/emp/doe.txt?op- =2HTTP/A.l Host:example.distfs.cn" Accept:application/json 19
GB/T31916.3一2018 Content-Type;applieation/jsonm Authorization;15IUYRRTY876(oU4D 'name";"docl.txt" 响应消息 HTTP/1.1200OK Date:Sun，6Feb201118;10;00GMT Content-Type;application/json Server:example.,distfs,en 7.9查看文件状态 7.9.1功能描述 查看文件状态的操作参数为:FileStatus,用于在分布式文件存储中查看文件状态
7.9.2请求定义 GET/Aceount)/Path)?op=filestatusHTTP/1. Host:[HostName] Accept:application/json Content-Type:application/json Authorization:[SigatureValue 7.9.3请求URL http://example.distfs,cn/《Account》/Path>/ 其中;(Account)表示账户ID,(Path)表示文件的路径
7.9.4请求消息头 按公共请求头定义 7.9.5请求消息参数 7.9.6请求消息体 无
7.9.7响应状态码 响应状态码及其描述见表24
表24响应状态码 状态码 描述 200 OK,查询成功 400 lnvalidFileName,文件名称不符合命名规则 20
GB;/T31916.3一2018 表24续) 状态码 描述 Unauthorized,用户没有传人验证信息或验证信息不正确 401 den,用户没有访问该文件的权限 403 Forbidde 04 NoSuehiFile,用户请求的文件路径不存在 501 Notlmpemented,服务器不支持此功能接口 7.9.8响应定义 HTTP/1.1200OK Date:date ContentType，aplieation/jsonm Content-Length:length Server:server accesstime":int， blocksize":int XXXXX XXX ication":int trashtime xxx 7.9.9响应消息头 按公共响应头定义
7.9.10响应消息体 响应消息体中各参数描述见表25
表25响应消息体 参数 名称 类型 描述 选择状态 文件访问次数 accesstimme int 文件访问次数 必选 文件块大小 文件块大小,以MB为单位 locksize int 必选 文件所有人 文件的所有人 必选 owner string 文件权限 表示可读,w表示可写,x表示可执行 必选 permission string 文件的创建时 l时间的格式由GB/T7408一2005定义，如;:2006-1l1 ctime string 必选 18To6:12;00 间截 正整数十单位,格式如12min，单位包括秒s)、分 回收站保存时间 string 必选 trashtime min)、小时(h、天(d)、月M
GB/T31916.3一2018 7.9.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 GET/MyAccount/temp/doc.txt?op=filestatusHTTP/1. Host:example.distfs.cen Accept:application/jsom Content-Type:applieation/json Authorization;15IUYRRTY876OIU4D 响应消息: HTTP/1.1200OK Date:Sun,6Feb201118;l0;00GMT Content-Type:applieation/json Content-length:98 Server;example.distfs.cn 'accesstime":l43 "blocksize";64， OneT :"MyAccount" permision""rw" 'replieation":3 "2006-11-18To6;12,00" 'ctime 'trashtime";"1d" 7.10修改文件属性 7.10.1功能描述 修改文件属性的操作参数为:ModifyFileAttribute,用于在分布式文件存储中修改文件属性 7.10.2请求定义 PUT/Account>/Path>？?op=mo nodifyfileattributeHTTP/1.1 Host:[HostName application/json Accept aplieae Content-Type tion/json reValue Authorization h[Sigiur "Xxx permission" replication";int xXx trashtime 7.10.3请求URL http://example.distfs.cn/Account)/Path>/ 22
GB;/T31916.3一2018 其中:(Account)表示账户ID,(Path)表示欲修改的文件的路径
7.10.4请求消息头 按公共请求头定义
7.10.5请求消息参数 无
7.10.6请求消息体 请求消息体中各参数描述见表26
表26请求消息体 名称 类型 参数 描述 选择状态 文件权限 r表示可读,w表示可写,x表示可执行,默认值为rwx 可选 permission string -512之间的正整数,应大于或等于系统最低文件副 0一 repliecation 文件副本数目 int 可选 本数
默认值;原文件副本数 正整数十单位,格式如12min
单位包括秒s),分 回收站保存时间 小时(h),天(d),月(M)
最大值为24个月
默 可选 trashtime string min 认值;原回收站保存时间 7.10.7响应状态码 响应状态码及其描述见表27
表27响应状态码 状态码 描述 200 OK,修改属性成功 nvalidFileName,文件名称不符合命名规则 400 400 nvalidPermission,文件权限参数不正确 InvalidReplicationNumber， r,用户请求修改的文件副本数目不是0一512之间的正整数或小于系统最低文件 400 副本数 400 nvalidIrnshTimme,保存时间不符合格式或超过24个月 40l Unauthorized ,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有修改文件的权限 404 NoSuchFile,用户请求的文件路径不存在 Notlmplemented,服务器不支持此功能接口 501 7.10.8响应定义 HTTP/1.1200OK Date:date Content-Type:applieation/json 23
GB/T31916.3一2018 Server: server 7.10.9响应消息头 按公共响应头定义 7.10.10响应消息体 无. 7.10.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 PUT/MyAccount/temp/doe.txt?op=modifyfileattributeHTTP/1. Host:example.distfs.cn Accept;applieation/json content-Type:applieation/json 15IUYRRTY876(oIU4D Authorization;l "permission";"r" 'replieation" trashtine";"7d" 响应消息 HTTP/1.1200OK Date:Sun，6Feb201118;10;00GMT Content-Type:appliecation/json Server:example,distfs.cn 7.11文件搜索 7.11.1功能描述 文件搜索的操作参数为;FileSeareh,用于在分布式文件存储中搜索文件
7.11.2请求定义 GETAccount)/Path)?op=filesearch[&.exaetmatch=true/false]HTTP/1.1 Host:[HostName Accept:application/json ContentIype;appleation/jsom Authorization,[signaureYalue "keyword""xxxxxx 7.11.3请求URL http://example.distfs.cn/Account)/Path>/ 24
GB;/T31916.3一2018 其中:(Account)表示账户ID,(Path)表示搜索位置
7.11.4请求消息头 按公共请求头定义 7.11.5请求消息参数 请求消息参数见表28
表28请求消息参数 参数 名称 类型 描述 选择状态 true表示精确匹配，false表示不精确匹配，默认值 exactmatch 精确匹配标记 boolean 可选 为false 7.11.6 请求消息体 请求消息体中各参数描述见表29
表29请求消息体 参数 名称 类型 描述 选择状态 keyword 搜索关键字 string 支持通配符“关”,可以匹配任意字符串 必选 7.11.7响应状态码 响应状态码及其描述见表30
表30响应状态码 状态码 描述 OK,搜索成功 200 nvaladFolderName,指定的搜索文件夹不符合命名规则 400 01 t ized,用户没有传人验证信息或验证信息不正确 nauthori 03 Forbidden,用户没有访问搜索位置的权限 404 NoSuchFolder,指定的搜索文件夹不存在 501 Notlmplemented,服务器不支持此功能接口 7.11.8响应定义 HTTP/1.1200OK Date:date ， content-Type:application/json Content-L.ength:length Server serer 25
GB/T31916.3一2018 "ilel""xxxxxx "ile2""xxxx" 7.11.9响应消息头 按公共响应头定义 7.11.10响应消息体 响应消息体中各参数描述见表31
表31响应消息体 选择状态 参数 名称 类型 描述 lel,hle2文件名搜索结果 搜索到的文件名 string 必选 7.11.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息" GET/MyAccount/temp?op=filesearchHTTP/1. Hostexample.distfs.cn Accept:application/json ontent-Ty -Type:application/json Authorization;l5IUYRRTY876OIU4D "keyword":"my”" 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118;10,00GMT Content-Type;applieation/json Content-l.ength:68 Server:example.distfs.cn "filel";"/MyAecount/temp/mydoc.,txt" "file2""/MyAccount/temp/mypicture,jpg" 7.12读文件 7.12.1功能描述 读文件的操作参数为:FileRead,用于在分布式文件存储中读文件 7.12.2请求定义 GETAeccount)/(Path)”op=fleread[&.ofset=long][&.length=long]HTTP/A.1 26
GB;/T31916.3一2018 Host:[HostName] Accept:text/plainm Content-Type:appication/json Authorization;[SigatwreVwalue] 7.12.3请求URL. http://example.distfs.cm/(.Aecount>/Path/ 其中:(Ae nt)表示账户ID,(Path)表示文件路径
ccoun 7.12.4请求消息头 按公共请求头定义
7.12.5请求消息参数 请求消息参数见表32
表32请求消息参数 类型 参数 描述 选择状态 名称 以Byte为单位的非负整数,表示从文件的何处开始读 ofset 起始位置 long 可选 取
应小于或等于文件长度
默认值0 默 以Byte为单位的非负整数,表示文件读取的长度
length 读取长度 long 可选 认值;文件长度 7.12.6 请求消息体 7.12.7 响应状态码 响应状态码及其描述见表33
表33响应状态码 状态码 描述 200 oK,读取成功 400 InvalidFileName,指定的文件不符合命名规则 nvalidOffset,起始位置无效 400 400 InvalidlL.ength,读取长度无效 Unauthorizxed,用户没有传人验证信息或验证信息不正确 401 Forbiden,用户没有读该文件的权限 403 uehril,用户请求的文件不存在 NoSue 404 501 Notlmplemented,服务器不支持此功能接口 27
GB/T31916.3一2018 7.12.8响应定义 HTTP/1.1200O)K Date:date Content-Type:text/plain Content-length:length Server:server fledata) 7.12.9响应消息头 按公共响应头定义 7.12.10响应消息体 响应消息体中各参数描述见表34
表34响应消息体 选择状态 参数 名称 类型 描述 filedata 文件内容 文件内容 string 必选 7.12.11请求和响应示例 请求消息和响应消息见示例
示例" 请求消息" GET /doe.txt?op=flereadHTTP/1.1 AyAcout/emp/" Host:example.distfs.cn Accept:text/plain Content-Type:applieation/json Authorization:15IUYRRTY876OIU4D 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118;10;00GMT Content-Type:text/plain Content-length:13 Server:example.distfs.cn Hello,world" 7.13写文件 7.13.1功能描述 写文件的操作参数为;Filewrite,用于在分布式文件存储中写文件
7.13.2请求定义 PUT/Account)>/(Path)?op=filewrite&.offset=long&.length=longHTTP/1.1 28
GB;/T31916.3一2018 Host:[HostName] Accept:application/jsonm Content-Type:text/plain Authorization;[SignatureValue filedata 7.13.3请求URL http://example.distfs.cn/
GB/T31916.3一2018 表37(续) 描述 状态码 ,用户没有传人验证信息或验证信息不正确 401l Unauthorized 403 Forbidden,用户没有写该文件的权限 NoSuchFile,用户请求的文件不存在 404 501 Notlmpemented,服务器不支持此功能接口 7.13.8响应定义 HTTP/1.1200OK Date:date C， Content-Type;text/plain C， Content-length:length Server server 7.13.9响应消息头 按公共响应头定义
7.13.10响应消息体 无
7.13.11请求和响应示例 请求消息和响应消息见示例 示例 请求消息 PUT/MyAccount/temp/doe.txt?op=filewirte8.offset=08.length=13HTTP/1.1 Host:example.distfs.cen Accept;text/plain Content-Type;text/plain Authorization:15IUYRRTY876OIU4D Hello,world" 响应消息 HTTP/1.1200OK Date;Sun，6Feb201118:10;00GMT Content- Tye text/plain Content-l.ength:13 Server:example,distfs.cn 8 文件夹接口要求 8.1概述 分布式文件存储的文件夹接口是对系统中的文件夹进行操作的接口,包括创建文件夹、删除文件 30
GB;/T31916.3一2018 夹、上传文件夹、下载文件夹、复制文件夹、重命名文件夹、查看文件夹状态、修改文件夹属性、文件夹搜 索和列出文件夹内容
文件夹接口是必选接口
8.2创建文件夹 8.2.1功能描述 创建文件夹的操作参数为:Mkdir,用于在分布式文件存储中创建文件夹
创建的文件夹名应在其 父文件夹中唯一
8.2.2请求定义 PUT/Account/Path)? =mkdir&.name=xxx[&.overwrite=true/false] op= [&.permission=xxx]HTTP/1.1 Host:[HostNamme Accept:applieation/json Content-Type:application/json Authorization:[SignatureValue 8.2.3请求URL http://example.distfs.cn/《Account>/(Path) 其中:(Account)表示账户ID,(Path)表示创建文件夹的位置
8.2.4请求消息头 按公共请求头定义
8.2.5请求消息参数 请求消息参数见表38
表38请求消息参数 参数 名称 类型 描述 选择状态 文件夹名称 tring 其名称应符合6.2中所述的文件命名规则 必选 name 文件夹重名覆盖 表示可覆盖,false表示不允许覆盖,默认值为falee 可选 overwrite b0olean true 标记 permission 文件夹权限 string r表示可读,w表示可写,x表示可执行,默认值为rwx 可选 8.2.6请求消息体 8.2.7响应状态码 响应状态码及其描述见表39
31
GB/T31916.3一2018 表39响应状态码 状态码 描述 200 OK,创建成功 400 nvaliadFolderName,文件夹名不符合命名规则 400 nvalidPermission， 文件夹权限参数不正确 401 Unauthorized,用户没有传人验证信息或脸证信息不正确 403 Forbidden,用户没有创建文件夹的权限 404 NoSuchFolder,用户请求的文件夹路径不存在 FoderAlreadyExists,用户创建的文件夹名与已有文件夹重名,并且重名覆盖标记为lse 409 Implemented,服务器不支持此功能接口 501 Not 8.2.8响应定义 HTTP/1.1200OK Date:date conent-Type，pplieatiom/jon Content-length:length Server:server "ctime':"XxXxxx 8.2.9响应消息头 按公共响应头定义
8.2.10响应消息体 响应消息体中各参数描述见表40. 表40响应消息体 参数 名称 类型 描述 选择状态 时间的格式由 文件夹创建时 GB/T7408一2005定义，如:2006-ll 必选 ctime string 间戳 18To6;12;00 8.2.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 PUT HTTP/A.1 /MyAccount/temp?op=mkdir&.name=tmp8.overwrite=true&.permission=rwx Host:example.distfs.cn Accept:application/json 32
GB;/T31916.3一2018 Content-Type:applieation/jsonm Authorization:l5IUYRRTY876OIU4D 响应消息: HTTP/ 1.1200OK Date:Sun，6Feb201118;10;00GMT phane ion/json Content-Type; content-length:24 Server;example.distfs.cn e";"2006-l1-18To6;12;00 "ctime"" 8.3删除文件夹 8.3.1功能描述 删除文件夹的操作参数为:Rmdir,用于删除文件夹
删除文件夹时系统应将之放人回收站
8.3.2请求定义 DELETE/Account>/Path)？op=rmdir&.name=xxx[&.recursive=true/alse]HTTP/1.1 Host:[HostName Accept:applieation/json Content-Type:applieation/json Authorization:[SignaureVlue] 8.3.3请求URL t/Path/ http://example.distfs.cn/
GB;/T31916.3一2018 8.4上传文件夹 8.4.1功能描述 上传文件夹的操作参数为:UploadFolder,用于上传本地的文件夹到分布式文件存储
8.4.2请求定义 PUT/Account =0[1|2|3] .overwrite= nt)/Path)?op=uploadfolder&-[&o [&permission=xxx灯HTTP/1.1 Host:[HostName] Accept:application/json Content-Type:appication/json Authorization:[SignatureValue "localpath""xxxxxx" 8.4.3请求URL http://example.distfs.cn/Account)>/Path>/ 其中:(Account)表示账户ID.(Path)表示上传到的文件夹的位置
8.4.4请求消息头 按公共请求头定义
8.4.5请求消息参数 请求消息参数见表43
表43请求消息参数 名称 类型 选择状态 参数 描述 0表示可覆盖,1表示不允许覆盖,2表示自动重命名为 FolderName-1 1,.Fdden 文件夹重名覆益 inme-2以此类推,3表示合并 可选 overwrite nt 标记 合并中如有文件同名则自动重命名为FileName-1、 FileName-2以此类推)
默认值为" permission 文件夹权限 tring r表示可读,w表示可写,x表示可执行,默认值为rwx 可选 8.4.6请求消息体 请求消息体中各参数描述见表44
表44请求消息体 名称 类型 选择状态 参数 描述 本地文件夹位置 其名称应符合6.2中所述的文件命名规则 必选 string loealpath 35
GB/T31916.3一2018 8.4.7响应状态码 响应状态码及其描述见表45. 表45响应状态码 状态码 描述 oK,上传成功 200 InvalidFolder 400 Name,文件夹名称不符合命名规则 400 lnvalidPermission. 1,文件夹权限参数不正确 400 nvalidFileSize,用户请求上传的文件夹中有文件大于系统设定的最大文件大小值 401 Unauthorized,用户没有传人验证信息或验证信息不正确 403 Forbdden,用户没有在文件夹中创建文件的权限 404 NoSuchFolder,用户请求的文件夹路径不存在 FolderAIreadyExists,用户请求上传文件夹名与已有文件夹重名,并且重名覆盖标记为1 409 Implemented,服务器不支持此功能接口 501 Not 8.4.8响应定义 HTTP/1.1200OK Date:date Content- -Type:applieation/json Content-l.ength;length Server:server "folderpath";"xxxxxx "ctime";"xxxxxxxxx 8.4.9响应消息头 按公共响应头定义
8.4.10响应消息体 响应消息体中各参数描述见表46. 表46响应消息体 参数 名称 描述 类型 选择状态 folderpath上传位置 文件夹上传的位置 必选 string etime 文件夹创建时间截 string时间的格式由GB/T7408一2005定义,如:2006-1l-18To6:12:00 必选 8.4.11请求和响应示例 请求消息和响应消息见示例
36
GB;/T31916.3一2018 示例 请求消息 UT/MyAceowm/emp?p=pbmdodlder&orwrie=2&pemiesion=rwxHTTPA Host:example.distfs.cn aplhtatom/jon Accept Content-Type:application/json Authorization:15IUYRRTY876OU4D locapath";"C;\myfolder" 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118;10;00GMT Content-Type;application/json Content-I.ength:58 example.distfs.en "folderpath","/MyAecount/temp/myfolder", "etime";"2006-11-18To6:12;00" 8.5下载文件夹 8.5.1功能描述 下载文件夹的操作参数为:DownloadFolder.用于将文件夹从分布式文件存储下载到本地 8.5.2请求定义 GETAecount)/(Path)?op=downloadfolderHTTP/1.l Host:[HostNameT Accept:applieation/json Content-Ty pliestiom/jon ype: reValue Authorization [Sigaur "localpath" XxxxXX aliasname XXXXXX 8.5.3请求URL http://example.distfs.cn/《Account)/(Path) 其中;(Aecount)表示账户ID,(Path)表示欲下载的文件夹的位置
8.5.4请求消息头 按公共请求头定义
8.5.5请求消息参数 无 37
GB/T31916.3一2018 8.5.6请求消息体 请求消息体中各参数描述见表47
表47请求消息体 参数 名称 类型 描述 选择状态 本地文件夹位置 其名称应符合6.2中所述的文件命名规则 localpath string 必选 文件夹另存名 其名称应符合6.2中所述的文件命名规则 可选 aliasname string 8.5.7响应状态码 响应状态码及其描述见表48. 表48响应状态码 状态码 描述 200 OK，下载成功 400 nvaldFoderName,文件夹名称不符合命名规则 Unauthorized 401l 用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有在文件夹中读取文件的权限 NoSuchFoder,用户请求的文件夹路径不存在 404 Notlmpemented,服务器不支持此功能接口 501 8.5.8响应定义 HTTP/1.1200oK Date:date Content-Type:application/json Server:server 8.5.9响应消息头 按公共响应头定义 8.5.10响应消息体 无 8.5.11请求和响应示例 请求消息和响应消息见示例 示例 请求消息 HTTP/1. cET/MyAcou/emp/audao? op=downloadfolder Host:example.distfs.cn Accept:application/json 38
GB;/T31916.3一2018 Content-Type:application/jsonm Authorization:15IUYRRTY876OIU4D "localpath";"C;\myfolder" 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118:10;00GMT Content-Type;applieation/jsonm Server:example.distfs.cn 8.6复制文件夹 8.6.1功能描述 复制文件夹的操作参数为CopyFolder,用于在分布式文件存储中复制文件夹 8.6.2请求定义 PUTAccount>)/(Path>?op=copyfolder[&.overwrite=01l2|3]HTTP/1.1 Host:[HostName Accept:application/json Conent-Typeaplieation/json Authorization;[signalureValue "destpath";"xxxxxx "aliasname""xxxxx"" 8.6.3请求URI http;//example.distfs.en/Account)>/Path/ 其中;(Account)表示账户D,(Path)表示欲下载的文件夹的位置
8.6.4请求消息头 按公共请求头定义
8.6.5请求消息参数 请求消息参数见表49
表49请求消息参数 参数 名称 类型 描述 选择状态 0表示可覆盖，表示不允许覆盖，2表示自动重命名为 文件夹重名覆盖 IFolderName-l、FolderName-2以此类推,3表示合并 overwrite int 可选 标记 合并中如有文件同名则自动重命名为FileName-1 lFileName-2以此类推)
默认值为1 39
GB/T31916.3一2018 8.6.6请求消息体 请求消息体中各参数描述见表50 表50请求消息体 参数 名称 类型 描述 选择状态 destpath 目标文件夹位置 string 其名称应符合6.2中所述的文件命名规则 必选 aliasname 文件夹的另存名 string 其名称应符合6.2中所述的文件命名规则 可选 8.6.7响应状态码 响应状态码及其描述见表51
表51响应状态码 状态码 描述 oK,复制成功 200 lnvalidFolderName, ,文件夹名称不符合命名规则 400 401 Unauthorize aed,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有在源文件夹中读取文件的权限 403 Forbidden,用户没有在目标文件夹中写的权限 404 NoSuchFolder,用户请求的文件夹路径不存在 409 FolderAlreadyExists,复制文件夹名或别名与已有文件夹重名,并且重名覆盖标记为1 Notlmplemented,服务器不支持此功能接口 501 8.6.8响应定义 HTTP/1.1200OK Date:date Content-Type:application/json Content-Length:length Server:server "ctime" "xxxxxxxxxx" 8.6.9响应消息头 按公共响应头定义
8.6.10响应消息体 响应消息体中各参数描述见表52 40
GB;/T31916.3一2018 表52响应消息体 参数 名称 类型 描述 选择状态 文件夹创建时 时间的格式由GB/T74082005 定义，如:2006-1m 必选 ctime string 间戳 18To6;12:00 8.6.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息: audio'?op= -eopyfodar& verwrite=2HTTP/1.1 PUT/MyAccount/emp Host:example.distfs.cn AAceept:applieation/json Content-Type:applieation/json 1;15IUYRRTY876OIU4D Authorization:;l destpath";"/MyAccont/temp/musie" 响应消息: HTTP/1.1200oK Date:Sun，6Feb201118:10;00GMT Content-Type:application/json Content-I.ength:24 Server:example.distfs.cn "etinme";"2006-11-18To6;12;00' 8.7重命名文件夹 8.7.1功能描述 重命名文件爽的操作参数为;RenameFolder,用于在分布式文件存储中重命名文件夹
8.7.2请求定义 PUT/Account)>/(Path)?op=renamefolder[&.overwrite=0l1l23]HTTP/1.l Host:[HosName] Accept:application/json Content-Type:applieation/json Authorizati ion:[SignatureValn lue "name" Xxxxxx 8.7.3请求URL htp://example.distf.cen/Acoum)>/Path 其中:(Ae nt)表示账户lID,(Path)表示欲重命名的文件夹的位置
ccount 41
GB/T31916.3一2018 8.7.4请求消息头 按公共请求头定义 8.7.5请求消息参数 请求消息参数见表53 表53请求消息参数 参数 名称 类型 描述 选择状态 l0表示可覆盖,1表示不允许覆盖,2表示自动重命名为 FolderName-1、FolderName-2 文件夹重名覆盖 以此类推,3表示合并 可选 overwrite int 标记 合并中如有文件同名则自动重命名为FileName-1、 [FileName-2以此类推)
默认值为1 8.7.6请求消息体 请求消息体中各参数描述见表54
表54请求消息体 选择状态 参数 名称 类型 描述 name 文件夹新名称 其名称应符合6.2中所述的文件命名规则 string 必选 8.7.7响应状态码 响应状态码及其描述见表55
表55响应状态码 状态码 描述 200 oK,重命名成功 400 InvalidFolderName, ,文件夹名称不符合命名规则 401 Unauthorized,用户没有传人验证信息或验证信息不正确 Forbidden,用户没有修改文件夹的权限 403 404 NoSuchFoder,用户请求的文件夹路径不存在 409 FolderAlreadyExists,文件夹新名与已有文件夹重名,并且重名覆盖标记为1 NotImplemented,服务器不支持此功能接口 50l 8.7.8响应定义 HTTP/1.1200OK Datedate Content-Type:applieation/json Server: server 42
GB;/T31916.3一2018 8.7.9响应消息头 按公共响应头定义 8.7.10响应消息体 无
8.7.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 PUr/MyAccount/tenp/audio?op=renanefoder&.overwrite=2HTTP/1. Hostexample.distfs.cn Accept:applieation/json Content-Type;applieation/jsonm uthorization:15IUYRRTY876OIU4D name mus1c 响应消息 HTTP/1.1200OK Date;Sun，6Feb201l18;l0;00GMT Content-Type:application/json Server;example.distfs.cn 8.8查看文件夹状态 8.8.1功能描述 查看文件夹状态的操作参数为;FolderStatus,用于在分布式文件存储中查看文件夹状态
8.8.2请求定义 GETAccount)/Path)?op=folderstatusHTTP1.1 Hlost:HostName Aeept，applieation/jsonm Content-Type applieation/json Authorization:[SignatureValue 8.8.3请求URL htp://example.ditfs.cn/Acoum)/Pah)/ 其中:(Account)表示账户ID,(Path)表示文件夹的位置
8.8.4请求消息头 按公共请求头定义
8.8.5请求消息参数 无 43
GB/T31916.3一2018 8.8.6请求消息体 8.8.7响应状态码 响应状态码及其描述见表56
表56响应状态码 状态码 描述 OK,查询成功 200 nvalidFolderNanme,文件夹名称不符合命名规则 400 40l Unathorized,用户没有传人验证信息或验证信息不正确 403 Forbidde den,用户没有访问该文件夹的权限 404 NosuchFolder,用户请求的文件夹路径不存在 NotImpemented,服务器不支持此功能接口 501 8.8.8响应定义 HT'TP/1.l200O)K Date:date content-Type，applieation/ 1/json Content-l.ength;length Server:server accesstimeint
ilenumber" int， owner XXxx permision" XXX ctime xxXXxxxxxx 8.8.9响应消息头 按公共响应头定义 8.8.10响应消息体 响应消息体中各参数描述见表57
表57响应消息体 选择状态 参数 名称 类型 描述 文件夹访问次数 文件夹访问次数 必选 accesstIme Int filenumber 文件夹中文件数目 int 文件夹中文件数目 必选 44
GB;/T31916.3一2018 表57(续) 参数 名称 类型 描述 选择状态 文件夹所有人 string文件夹的所有人 owner 必选 文件夹权限 string文件夹权限 必选 permission 时间的格式由GB/T74082005定义,如;2006-11-18To6 ctime 文件夹创建时间截 必选 strIng 12;00 8.8.11 请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 GET/MyAccount/temp/audio?op=folderstatusHTTP/1.1 Host:example.distfs.cn Acceept:applieation/json Content-Type:aplieation/jsonm Authorization:l151UYRRTY876OU4D 响应消息 HTTP/1.1200OK Date:Sun6Feb201118:10;00GMT ContentType，applieation/json Content-length;68 example.distfs.cn" accesstime":56. 23， Accouunt O1Tne permision';'rwx cetime""2006-11-18To6;12,00" 8.9修改文件夹属性 8.9.1功能描述 修改文件夹属性的操作参数为:ModifyFolderAttribute,用于在分布式文件存储中修改文件夹 属性
8.9.2请求定义 PUTAccount)/(Path)?op=modifyfolderattributeHTTP/1. Hot:[HostNams Accept:application/json Content-Type:application/json Authorization;[SignatureValue 45
GB/T31916.3一2018 "xxx" "permission" 8.9.3请求URL htp://example.distfs.cn/Account)>/(Path》 其中:(Account)表示账户ID,(Path)表示欲修改的文件夹的位置
8.9.4请求消息头 按公共请求头定义
8.9.5请求消息参数 无
8.9.6请求消息体 请求消息体中各参数描述见表58
表58请求消息体 参数 名称 类型 描述 选择状态 可选 文件夹权限 r表示可读,w表示可写,x表示可执行,默认值为 permmission string rwx 8.9.7响应状态码 响应状态码及其描述见表59
表59响应状态码 状态码 描述 200 OK,修改属性成功 400 lnvalidFolderName,文件夹名称不符合命名规则 400 InvalidPermission,文件夹权限不正确 401 Unauthorized,用户没有传人验证信息或验证信息不正确 Forbhidden,用户没有修改文件夹的权限 403 ShFdler,用户请求的文件夹路径不存在 404 No.S 501 Notlmplemented,服务器不支持此功能接口 8.9.8响应定义 HTTP/1.1200O)K Date;date ContentType:application/json Server:server 46
GB;/T31916.3一2018 8.9.9响应消息头 按公共响应头定义 8.9.10响应消息体 无
8.9.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 PUT/MyAccount/temp/audio?op=modifyfolderattributeHTTP/1.1 Host:example.distfs.cn AAccept:application/jsonm Content-Type:applieation/jsonm Authorization:l15IUYRRTY876OU4D permission":"rw" 响应消息 HTTP/1.1200OK GMT Date:Sun，6Feb201118:l0;00！ Content-Type:applieation/jsonm Server:example.distfs.cn 8.10文件夹搜索 8.10.1功能描述 文件夹搜索的操作参数为;FolderSeareh,用于在分布式文件存储中搜索特定名称的文件夹
8.10.2 请求定义 GETAccount)>/Path)?op=folderseareh[&.exactmatch=true/alse]HTTP/1.1 Host:[HostName Accept:application/json Content-Type applieation/jon Authorization:[SignatureValue "keyword";"xxxxxx" 8.10.3请求URL hutp://example.distfs.cn/Accounm)/Path)/ 其中:(Account)表示账户ID,(Path)表示搜索位置
8.10.4请求消息头 按公共请求头定义
47
GB/T31916.3一2018 8.10.5请求消息参数 请求消息参数见表60 表60请求消息参数 类型 选择状态 参数 名称 描述 表示精确匹配,false表示不精确匹配，默认值 true 精确匹配标记 boolean 可选 exactmatch 为false 8.10.6请求消息体 请求消息体中各参数描述见表61
表61请求消息体 参数 类型 描述 名称 选择状态 必选 关键字 搜索关键字 keyword string 8.10.7响应状态码 响应状态码及其描述见表62
表62响应状态码 状态码 描述 OK,搜索成功 200 nvalidFolderName,指定的搜索文件夹不符合命名规则 400 401 Unauthoriz ued,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有访问搜索位置的权限 501 Notlmplemented,服务器不支持此功能接口 8.10.8响应定义 HTTP/1.1200OK Date:date Content-Type:application/json Content-Length:length Server:server "pathl";"xxxxxx" "path2""xxxx" 48
GB;/T31916.3一2018 8.10.9响应消息头 按公共响应头定义
8.10.10响应消息体 响应消息体中各参数描述见表63
表63响应消息体 选择状态 参数 名称 类型 描述 path,path2文件夹名搜索结果 搜索到的文件夹名 string 必选 8.10.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 GET/MyAccount/temp?op=foldersearchHTTP/1.1 Hostexample.distfs.cn application/jsonm Accept: Content-Type:application/jsonm Authorization:l5IUYRRTY876OIU4D "keyword";"my" 响应消息: HTTP/1.1200OK Datesun，6Feb201118;10,00GMT Content-Type:applieation/jsonm Content-Length:68 Server:example.distfs.cn "pathl";"/MyAccount/temp/my_musie" "path2""/MyAccount/temp/my_document 8.11列出文件夹内容 8.11.1功能描述 列出文件夹内容的操作参数为:ListFolder,用于在分布式文件存储中列出文件夹里文件和子文 件夹
8.11.2请求定义 GET/Account)>/Path)>?op=listfolderHTTP/1.1 Host:[HostName] 49
GB/T31916.3一2018 Accept:applieation/json Content-Type:applieation/json Authorization:[SignatureValue 8.11.3请求URL http://example.distfs,cn/Account)/Path>/ 其中;(Aecount)表示账户ID,(Path)表示文件夹的位置
8.11.4请求消息头 按公共请求头定义
8.11.5请求消息参数 无 8.11.6请求消息体 8.11.7响应状态码 响应状态码及其描述见表64
表64响应状态码 状态码 描述 200 OK,查询成功 400 nvalidFolderNanme,文件夹名称不符合命名规则 Unauthorized,用户没有传人验证信息或验证信息不正确 401 403 Forbidden,用户没有访问该文件夹的权限 404 NoSuchFolder,用户请求的文件夹路径不存在 Implemented,服务器不支持此功能接口 50l Not 8.11.8响应定义 HT'TP/1.l200O)K Datedate ContentIype;appleation/jsom Content-Iength:length Server:server namel" XXXX name2" "xxxxxxx" 50
GB;/T31916.3一2018 8.11.9响应消息头 按公共响应头定义
8.11.10响应消息体 响应消息体中各参数描述见表65
表65响应消息体 参数 名称 类型 描述 选择状态 文件火内的文件或文件火的名称 name1 l,name2子文件名称 string 必选 请求和响应示例 8.11.11 请求消息和响应消息见示例
示例: 请求消息: GET/MyAccount/emp?op=listfolderHTTP/1. Host:example.distfs.cn Accept:application/json Content-Type:applieation/jsonm Authorization:l5IUYRRTY876OIU4D 响应消息: HTTP/1.1200oK Date:Sun，6Feb201118:10,00GMT content-Type:application/json Content-L.ength:68 Server:example.,distfs.cn audio/" namel""/MyAecount/emp/ name2";"/MyAccount/temp/doe.txt" 回收站接口要求 9.1概述 分布式文件存储的回收站接口是对系统中的回收站进行操作的接口
回收站是系统中一个特殊的 文件夹,用来存放用户删除的文件和文件夹
回收站接口包括还原回收站文件、查询回收站文件、彻底 删除回收站文件、清空回收站和全部还原
回收站接口是必选接口
g.2还原回收站文件 g.2.1功能描述 还原回收站文件的操作参数为;RecoverFile,用于还原回收站里的文件或文件夹
51
GB/T31916.3一2018 9.2.2请求定义 =recoverfileHTTP1.1 PUT/Account)?op- Host:[HostNamme Accept:application/json Content-Type:application/json Authorization:;[SignatureValue "objname" xXxXX 9.2.3请求URI http://example.distfs.cn/Account》 其中;(Account)表示账户ID 9.2.4请求消息头 按公共请求头定义
9.2.5请求消息参数 g.2.6请求消息体 请求消息体中各参数描述见表66
表66请求消息体 类型 选择状态 参数 名称 描述 回收站内的文件或文件夹的名称,其名称应符合6.2中 obname 文件名称 string 必选 所述的文件命名规则 9.2.7响应状态码 响应状态码及其描述见表67
表67响应状态码 状态码 描述 200 OK,还原成功 nvalidFleNanme目标名称不符合命名规则 400 Unauthorized,用户没有传人验证信息或验证信息不正确 40l NoSuchFile,用户请求的目标不存在 404 501 Notlmplemented,服务器不支持此功能接口 52
GB;/T31916.3一2018 9.2.8响应定义 HTTP/1.1200OK Dat hte:date Content-Type:applieatio/json Server:server 9.2.9响应消息头 按公共响应头定义 9.2.10响应消息体 无 9.2.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息: PUT/NMyAccount?op=recoverfleHTTP1.1 Host:example.distfs.cn AAceept:applieation/jsonm Content-Type;applieation/jsonm Authorization:l5IUYRRTY876OIU4D "objname";"doe.,txt" 响应消息 HTTP/1.1200OK Date:Sun，6Feb201118:10;00GMT Content-Type:application/json Server:example.distfs.cn 9.3查询回收站文件 9.3.1功能描述 查询回收站文件的操作参数为:QueryTrash,该接口用于查询回收站里的文件或文件夹的信息
9.3.2请求定义 GET/Account>)?op=querytrashHTTP/1.1 Host:[HostName Accept:applieation/json content-Type:appliceation/json Athorization:[SgnatureVal lue "obiname XxXxxXx 53
GB/T31916.3一2018 9.3.3请求URL http://example.dhstfs.cm/Aeccouat) 其中;Account)表示账户ID g.3.4请求消息头 按公共请求头定义 9.3.5请求消息参数 无
9.3.6请求消息体 请求消息体中各参数描述见表68
表68请求消息体 参数 名称 类型 描述 选择状态 回收站中文件或文件夹的名称,其名称应符合6.2中所 objname 文件名称 必选 string 述的文件命名规则 9.3.7响应状态码 响应状态码及其描述见表69
表69响应状态码 状态码 描述 oK,查询成功 200 400 InvalidFileName,目标名称不符合命名规则 40l Unathorized,用户没有传人验证信息或验证信息不正确 404 NoSuchFile,用户请求的目标不存在 50l Notlmplemented,服务器不支持此功能接口 9.3.8响应定义 HT'TP/1.1200O)K Date:date Comten-Type;aPpliceation/小 son Content-ILe length Lengh Server:server "objname" XXXxxx "origpath" 'xxxxxx 54
GB;/T31916.3一2018 "objsize":int, "objetime" XXxXxxxx "objdtime" XxXXxXXx g.3.9响应消息头 按公共响应头定义
9.3.10响应消息体 响应消息体中各参数描述见表70.
表70响应消息体 参数 名称 类型 描述 选择状态 objname 文件名 string 文件或文件夹名 必选 原路径 文件或文件夹原路径 必选 origpath string 必选 文件大小 文件或文件夹大小,以yte为单位 objsize nt 文件或文件夹创建时间,时间的格式由GB/T7408- objetime 创建时间 date 必选 05定义.,如.206--18T67. 12:00 文件或文件夹的删除时间,时间的格式由GB/T7408- objdtime 删除时间 date 必选 05定义,如.26-I-18T6 12:00 g.3.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 GET/MyAccount?op=querytrashHTTP/1.l Host:example.distfs.cn Accept:applieation/json Content-Type:applieation/jsonm Authorization:l5IUYRRTY876OIU4D objname";"doc.txt" 响应消息: HTTP/1.1200OK Date;Sun，6Feb201118:10;00GMT Content-Type;application/json content-Length;68 Server:example,distfs.,cen "objname";"doe.txt" 'origpath";"/MyAccount/temp" ;10240. "objsize" 55
GB/T31916.3一2018 "objctime";"2006-l1-18To6:12;00" ","2o6ll1I8Tu7,12" "obidtime" 9.4彻底删除回收站文件 9.4.1功能描述 彻底删除回收站文件的操作参数为;FinalDeleteFile,用于彻底删除回收站里的文件或文件夹
g.4.2请求定义 DELETE/
GB/T31916.3一2018 9.5.2请求定义 o" DELETE/Account =cleartrashHTTP/1.1 op= Host:[HostName Accept:application/json ontent-Type:appiceation/json Authorization:;[SignatureValue 9.5.3请求URI http://example.distfs.cn/《Account7 其中;(Account)表示账户ID
9.5.4请求消息头 按公共请求头定义
9.5.5请求消息参数 无 g.5.6请求消息体 9.5.7响应状态码 响应状态码及其描述见表73. 表73响应状态码 状态码 描述 OK,清空回收站成功 200 401 Unauthorized,用户没有传人验证信息或验证信息不正确 Notlmplemented,服务器不支持此功能接口 501 9.5.8响应定义 HTTP/1.1200OK Date:date Content-Type:application/json Server:server 9.5.9响应消息头 按公共响应头定义
g.5.10响应消息体 无 58
GB;/T31916.3一2018 g.5.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 DELETE/MyAccount?op=cleartrashHTTP/1.1 Host:example.distfs.cn Acceept:aplieation/json Content-Type:application/jsonm Authorization:l15IUYRRTY876OU4D 响应消息: HTTP/1.1200oK Date:Sun6Feb201118:10;00GMT Content-Type;applieation/jsom Server:example.distfs.cnm 9.6全部还原 9.6.1功能描述 全部还原的操作参数为:Re ecover rAIl,用于还原回收站里的所有文件或文件夹
9.6.2请求定义 =recoverallHTTP/1.1 PUT/(Account)>?op= Host:[HostName application/json Accept Content-Type:applieation/json Authorization:[SignatureValue 9.6.3请求URL ://example.distfs.cn/《Account》 htp 其中;(Account)表示账户D
9.6.4请求消息头 按公共请求头定义
9.6.5请求消息参数 无 9.6.6请求消息体 无
9.6.7响应状态码 响应状态码及其描述见表74
59
GB/T31916.3一2018 表74响应状态码 状态码 描述 200 OK,全部还原成功 1,用户没有传人验证信息或验证信息不正确 401 [Unauthorized， 501 Notlmplemented,服务器不支持此功能接口 9.6.8响应定义 HTTP/1.l200O)K Date:date Content-Type aplieatiom/jon Server server 9.6.9响应消息头 按公共响应头定义 9.6.10响应消息体 无 9.6.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 PUT/MyAccount?op=recoverallHTTP/1.1 Host:example.distfs.cn Accept:application/jsonm Content-Type:application/jsonm Authorization:l5IUYRRTY876OIU4D 响应消息: HTTP/1.1200OK GMT Date;Sun，6Feb201118;l0;00 Content-Type;applieation/jsonm Server;example.,distfs,cn 10扩展属性接口要求 0.1概述 扩展属性是文件或文件夹的一种额外的应用级的属性,它不同于系统级的文件,文件夹属性(如权 限、修改时间等),系统级的属性会被文件系统读取并解析,扩展属性不会被文件系统解析,而是被外部 应用程序所用,用来存储额外的信息,比如存储一个文件的编码种类、摘要信息等 扩展属性以键值对的方式存储，一个文件或文件夹可以被赋予多个扩展属性
扩展属性的键是 个字符串,指明属性的名称,其格式为;命名空间.属性名,命名空间作为前缀,与属性名之间用小数点分 60
GB;/T31916.3一2018 隔,例如user.myattr
不同文件系统对于命名空间有不同的划分,例如将命名空间分为user,trusted、 system,security,不同用户对各个命名空间的访问权限不同
扩展属性的值是一个二进制数据,由用户 自定义 扩展属性的应用接口包括;设置、删除,读取、列出扩展属性
扩展属性接口是可选接口
10.2设置扩展属性 10.2.1功能描述 设置扩展属性的操作参数为SetXAttribute,用于在分布式文件存储中设置文件或文件夹的扩展 属性,包括添加和修改扩展属性
10.2.2请求定义 PUT/《Account)/《Path>?op=setxattribute8.xattr.name=xxx.xxx8.xattr.value=xxx [&.flag=ereatelreplace]HrTP/1.1 Hlost:HostName Aeept，applieation/json Content-Type:application/json Authorization:[SignatureValue 0.2.3请求URL http://example.distfs.cn/《Account>/(Path) 其中:(Account)表示账户D,(Path)表示文件或文件夹的位置
0.2.4请求消息头 按公共请求头定义
0.2.5请求消息参数 请求消息参数见表75
表75请求消息参数 参数 名称 类型 描述 选择状态 其格式为命名空间,属性名,命名空间与属性名之间用 小数点分隔,例如user.myattr
命名空间和属性名可用 Xattr.name 扩展属性名称 sstring 必选 字母、数字、下划线(_)、短横线(-)等,但应以字母、数字 开头,最长可允许256个字符 xattr.value 扩展属性值 byte 扩展属性的值 必选 lcreate表示添加扩展属性,replace表示修改已有扩展属 操作类型 可选 flag sstring 性,默认值为create 10.2.6 请求消息体 61
GB/T31916.3一2018 0.2.7响应状态码 响应状态码及其描述见表76. 表76响应状态码 状态码 描述 200 OK,设置扩展属性成功 400 lnvalidXAttrName,属性名称不符合命名规则 400 XattrAlreadyExists,添加属性时,属性名称已存在 400 NoSuchxatr,修改属性时,属性名称不存在 401 [Unauthorized， ,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有访问该文件或文件夹的权限 404 NoSuchFile,用户请求的文件或文件火路径不存在 501 NotImplemented,服务器不支持此功能接口 10.2.8响应定义 HT'TP/1.l200O)K Dat hue;rdate coneType，aplicet tion/json Server:server 0.2.9响应消息头 按公共响应头定义 10.2.10响应消息体 无
10.2.11请求和响应示例 请求消息和响应消息见示例 示例: 请求消息 PUT/MyAccount/temp?op=setxattribute&xattr.name=user.myattr&xattr.value=1&.flag=ereateHTTP/1.1 Host:example.distfs.cn COt" application/json Content-Type:application/json Authorization:l5IUYRRTY876OIU4D 响应消息: HTTP/1.1200OK Date;Sun，6Feb201118;10;00GMT ContentType;applieation/jsonm Server;example.distfs.,cn 62
GB;/T31916.3一2018 0.3删除扩展属性 10.3.1功能描述 删除扩展属性的操作参数为;RemoveXAttribute,用于在分布式文件存储中删除文件或文件夹的 扩展属性
0.3.2请求定义 PUTAccount>)/(Path)?op=renmovexattribute&xattr.name=xxx,.xxxHTTP/1.1 Host:[HostName] Accept:application/json Content-Type:applieation/json Authorization;[signalureValue] 0.3.3请求URL. n/Ac http://example.distfs.cn Account)>/Path》7 其中;(Account)表示账户ID,(Path)表示文件或文件夹的位置
0.3.4请求消息头 按公共请求头定义
0.3.5请求消息参数 请求消息参数见表77
表77请求消息参数 选择状态 参数 名称 类型 描述 其格式为:命名空间.属性名,命名空间与属性名之间用 小数点分隔,例如user.myatr
命名空间和属性名可用 扩展属性名称 必选 xattr.name string 字母、数字、下划线(_,短横线(-)等,但应以字母、数字 开头,最长可允许256个字符 0.3.6请求消息体 无 0.3.7响应状态码 响应状态码及其描述见表78. 表78响应状态码 状态码 描述 200 OK,删除扩展属性成功 nvalidXAttrName,属性名称不符合命名规则 400 63
GB/T31916.3一2018 表78(续) 状态码 描述 400 NoSucehXatr,属性名称不存在 401 Unauthorized,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有访问该文件或文件夹的权限 404 NoSuchFile,用户请求的文件或文件夹路径不存在 Notlmplemented,服务器不支持此功能接口 501 0.3.8响应定义 HTTP/1.l200O)K Date:date Content-Type:application/json Server:server 10.3.9响应消息头 按公共响应头定义
10.3.10响应消息体 无
10.3.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息: PUT/MyAccount/temp?op=removexattribute?xattr.name=user.myattrHTTP/1.1 Host:example.distfs.cen application/json Content-TypeaPplication/json uthorization:15IUYRRTY876(OIU4D 响应消息 HTIP/1.1200OK Date:Sun，6Feb201118;10,00GMT Content-Type:applieation/json Server;example.,distfs.,cn 10.4读取扩展属性 10.4.1功能描述 读取扩展属性的操作参数为;GetXAttribute,用于在分布式文件存储中读取文件或文件夹的扩展 属性,可以读取一个或多个扩展属性的键值
0.4.2请求定义 xxx2. GETAccount>/(Path>?op=getxattr tribute[&.xattr.name=xxx1&.x -Xattr
name 64
GB;/T31916.3一2018 T&.a sencoding= =xxx]HTTP/1. Hot:[HotName] Accept:application/json Content-Type:appication/json Authorization:[SignatureValue 0.4.3请求URL. http://example.distfs.cn/《Account)/(Path) 其中(Acount)表示账户D,(Path)表示文件或文件夹的位置 10.4.4请求消息头 按公共请求头定义 0.4.5请求消息参数 请求消息参数见表79 表79请求消息参数 选择状态 参数 名称 类型 描述 其格式为:命名空间.属性名命名空间与属性名之间用 小数点分隔,例如user.myattr
命名空间和属性名可用 字母、数字、下划线(_)短横线(-)等,但应以字母、数字 扩展属性名称 可选 xattr.name string 开头,最长可允许256个字符
该参数可以不指定或指定多个
如果不指定,则读取文 件或文件夹的所有扩展属性的键值 encoding 结果编码 string 用于显示读取结果的编码,缺省为GB2312 可选 10.4.6 请求消息体 无 0.4.7响应状态码 响应状态码及其描述见表8O
表80响应状态码 状态码 描述 200 oK,读取扩展属性成功 InvalidXAttrName, 属性名称不符合命名规则 400 400 NoSuechXattr,要读取的属性名称不存在 00 nvalidEncoding,指定的编码不正确 401 Unauthorized,用户没有传人验证信息或验证信息不正确 Forbidden,用户没有访问该文件或文件夹的权限 403 65
GB/T31916.3一2018 表80(续) 状态码 描述 404 NoSuchFile,用户请求的文件或文件夹路径不存在 Notlmplemented,服务器不支持此功能接口 501 10.4.8响应定义 HTTP/1.1200OK Date;date ContenTypeapplieation/ison Co ontent-length:length Server: server "XAttrs":C "name""XATTRNAME" value""XATTRVALUE1" 'name";"XATTRRNAME2" value";"XATTRVALUE2" 10.4.9响应消息头 按公共响应头定义 10.4.10响应消息体 响应消息体中各参数描述见表81
表81响应消息体 选择状态 参数 名称 类型 描述 扩展属性的键值对集合 JSON XAttrs 键值对集合 必选 扩展属性键名 name 扩展属性的键名 必选 string 扩展属性值 扩展属性的值 必选 value string 10.4.11请求和响应示例 请求消息和响应消息见示例
66
GB;/T31916.3一2018 示例 请求消息 GE:T/MyAccount/temp?op=getxattributeHrTP/1.1l Host:example.distfs.cn Accept:application/json Content-Type:applieation/jsonm l5UYRRTY876oU4D Authorization 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118:10;00GMT content-Type;applieation/jsonm Content-Length:70 example.distfs.cenm "XAttrs":D "name""user,a" "value "name";"user.b" "value";"2 10.5列出扩展属性 10.5.1功能描述 列出扩展属性的操作参数为ListxAttrilbute,用于在分布式文件存储中列出文什或文件夹的所有 扩展属性名称
10.5.2请求定义 GET/Account>/Path)?op=listxattributeHTTP/1.l Host:[HostNamme applieation/json Accet Content t-Type:applieation/json Authorization: ureValue x[si4aiu 0.5.3请求URL http://example.distfs.cn/
GB;/T31916.3一2018 示例 请求消息 GET/MyAccount/temp?op=listxattributeHTTP/1. Host:example.distfs.cn Accept:applieation/json Content-Type:application/json Authorization:l5IUYRRTY876OIU4D 响应消息 HTTP/1.1200OK Date:Sun，6Feb201118:10;00GMT Content-Type;applieation/jom Content-length:48 Server:example.distfs.cn "xAttrName";"["user.a\",\"user.b","useer.c\"]" 11 快照接口要求 1.1概述 快照是对文件系统的一个即时的、只读的拷贝，一般用于文件的备份、灾难恢复等
用户可以对整 个文件系统进行快照,也可以对文件系统的部分目录和文件进行快照
快照的应用接口包括;创建、删 除、,列出、重命名快照
快照接口是可选接口
11.2创建快照 1.2.1功能描述 创建快照的操作参数为:CreateSnapshot,用于在分布式文件存储中创建文件或文件夹的快照 1.2.2请求定义 pshot[8snapshotname=xxxHITTP/1.1 PUT/Account)/Path>?op=createsnap Host:[HostName] Accept:application/json Content-Type:application/json Authorization:[signatureValue 11.2.3请求URL. http://example.distfs.cn/Account)/Path)/ 其中:〈Account)表示账户ID,(Path)表示文件或文件夹的位置
11.2.4请求消息头 按公共请求头定义
11.2.5请求消息参数 请求消息参数见表84
69
GB/T31916.3一2018 表84请求消息参数 参数 名称 类型 描述 选择状态 可用字母、数字、下划线(_、短横线(-)、小数点等,但应 以字母,数字开头,最长可允许256个字符
系统自动 扫“YYYYMMD “sYYYYMMDDThhmms",其中 命名为" 可选 快照名称 Snapshotname string DThhmms”为时间截
若指定的名称与已有的快照重名,则自动重命名为 snapshotname-1,snapshotname2等,以此类推 11.2.6请求消息体 无
1.2.7响应状态码 响应状态码及其描述见表85 表85响应状态码 状态码 描述 200 OK,快照成功 InvalidSnapshotName,快照名称不符合命名规则 400 Unmauthorized,用户没有传人验证信息或验证信息不正确 401 403 Forbhidden,用户没有访问该文件或文件夹的权限 NoSuchFile,用户请求的文件或文件夹路径不存在 404 501 NotImplemen nted,服务器不支持此功能接口 11.2.8响应定义 HT'TP/1.l200O)K Date;date Content-Typeapplication/json Content-length:length Server:server '"path":"xxx" 11.2.9响应消息头 按公共响应头定义
11.2.10响应消息体 响应消息体中各参数描述见表86
70
GB;/T31916.3一2018 表86响应消息体 参数 名称 类型 描述 选择状态 path 快照存放路径 string 快照存放的路径 必选 1.2.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 PUT/MyAccount/temp?op=ereatsnapshot8.snapshotname=slHTTP/1.l Hostexample,distfs.cn Accept:applieation/json Content-Type:applieation/json Authorization:15IUYRRTY876OIU4D 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118:l10;00GMT Content-Type:application/json Content-I.ength:29 Server:example.distfs.cm "path""/user/.snapshot/s1" 11.3删除快照 11.3.1功能描述 删除快照的操作参数为;DeleteSnapshot,用于在分布式文件存储中删除文件或文件夹的快照
11.3.2 请求定义 DELETE/Account>/Path)?op=deletesnapshot&.snapshotname=xxxHTTP/1.1 Host:[HostName Accept applieation/json Content-Type:applieation/json Authorization:[SignatureValue 11.3.3请求URL ://e2 ple.distfs.cn/Account>/Path>/ hp 2xXamp 其中:(Account)表示账户ID
(Path)表示文件或文件夹的位置
1.3.4请求消息头 按公共请求头定义
11.3.5请求消息参数 请求消息参数见表87
71
GB/T31916.3一2018 表87请求消息参数 参数 名称 类型 描述 选择状态 可用字母、数字、下划线(_)、短横线(-),小数点等,但应 snapshotname快照名称 必选 string 以字母、数字开头,最长可允许256个字符 113.6请求消息体 无
11.3.7响应状态码 响应状态码及其描述见表88
表88响应状态码 状态码 描述 200 OK,设置扩展属性成功 400 InvalidSnapshotName,快照名称不符合命名规则 sSnapshot,快照不存在 400 NoSuuch Unauthorized,用户没有传人验证信息或验证信息不正确 401 403 Forbidden,用户没有访问该文件或文件夹的权限 404 NoSuchFile,用户请求的文件或文件夹路径不存在 501 Notlmplemented,服务器不支持此功能接口 11.3.8响应定义 HT'TP/1.l200O)K Date:date Content-Type:applieation/json Server:server 11.3.9响应消息头 按公共响应头定义
11.3.10响应消息体 无 11.3.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息" op=ddetesnapshot&.snapshotname=slHTTP/I. ELETE/MAeou/enp? Host:example.distfs.cn Accept:application/json 72
GB;/T31916.3一2018 Content-Type:applieation/jsonm Athorization;15IUYRRTY876oU4D 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118;10;00GMT Content-Type:application/json Server:example.distfs.cn 11.4列出快照 1.4.1功能描述 列出快照的操作参数为;listSnapshot,用于在分布式文件存储中列出文件或文件夹的所有快照
11.4.2请求定义 aphotHTTP/1. GET/Account》/《Path)？op=listsna N Host:[HostNamme] applieation/json Accept Content-Type:application/json Authorization:; dlureValue [sga 11.4.3请求URL. //example.distfs.cn/Account>》/Path>/ Hup:/ 其中:(Aecount)表示账户ID,(Path)表示文件或文件夹的位置
11.4.4请求消息头 按公共请求头定义
11.4.5请求消息参数 无
11.4.6请求消息体 11.4.7 响应状态码 响应状态码及其描述见表89
表89响应状态码 状态码 描述 200 OK,列出快照成功 401 Jnauthorized,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有访问该文件或文件夹的权限 NoSuchfFie,用户请求的文件或文件夹路径不存在 404 501 Notlmplemented,服务器不支持此功能接口 73
GB/T31916.3一2018 11.4.8响应定义 HTTP/1.1200O)K bher;date Content-Type;applieation/json Content- Length:length Server: server "napshots"[ tl" name "snapshotl time XxxXXxXxx t2" name 'snapshot time XXXXXXXx" 11.4.9响应消息头 按公共响应头定义 1.4.10响应消息体 响应消息体中各参数描述见表90.
表90响应消息体 参数 名称 类型 描述 选择状态 napshots 快照集合 JJSON 快照集合 必选 快照名称 string 快照名称 必选 name 快照的时间,时间的描述格式由RFc822定义,如;Sun., 快照时间 ime string 必选 18Nov200606:12;00GMT 1.4.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息 GET/MyAccount/temp?op=listsnapshotHTTP/1. Host:example.distfs.cen Accept:applieation/jsonm ContentType:application/json Authorization;15IUYRRTY876OIU4D 响应消息 74
GB;/T31916.3一2018 HTTP/1.1200OK GMT Date:Sun，6Feb201118;10;00 Content-Ty aplieateon n/json ype; Content-l.ength:116 example.distfs.cm Server "[ snapshots "name";"snapshotl" "time";"Sun，6Feb201l15;10;00GMT" "name";"snapshot2" "time";"Sun，6Feb2o1116:10,00GMT" 11.5重命名快照 1.5.1功能描述 重命名快照的操作参数为;RenameSnapshot,用于在分布式文件存储中重命名文件或文件夹的 快照
11.5.2请求定义 pshot&.oldname=xxx8.newname=xxxHT'TP/1.1 PUT/Account)/Path)?op=renamesnaps Host:[HostName Accept applieation/json Content -Type，applieation/jon" Authorization:[Si tuureValue ignal 1.5.3请求URL //example.distfs.cn/
GB/T31916.3一2018 表91(续) 参数 名称 类型 描述 选择状态 可用字母、数字、下划线(_,短横线(-)小数点等,但应 以字母、数字开头,最长可允许256个字符
若指定的 快照新名称 newname string 必选 名称与已有的快照重名，则自动重命名为 lnapshotnamte-1,snapshotname-2等,以此类推 11.5.6请求消息体 无
11.5.7响应状态码 响应状态码及其描述见表92 表92响应状态码 状态码 描述 200 OK,重命名快照成功 nvalidSapshotName,快照名称不符合命名规则 400 Nosuehsnapshot,要修改的快照不存在 400 401 Unauthoriz aed,用户没有传人验证信息或验证信息不正确 403 Forbidden,用户没有访问该文件或文件夹的权限 404 NoSuchFile,用户请求的文件或文件夹路径不存在 501 Notlmplemented,服务器不支持此功能接口 11.5.8响应定义 HTTP/1.1200oK Date:date Content-Type:application/json Server:server 11.5.9响应消息头 按公共响应头定义
11.5.10响应消息体 无
1.5.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 76
GB;/T31916.3一2018 PUT/MyAccount/temp?op=renamesnapshot&.oldnanme=s1&.newname=s2HTTP/1.1 Host:example.distfs.cn Accept:applieation/json Content-Type:application/jsonm Authorization:l5IUYRRTY876OIU4D 响应消息 HTTP/1.1200OK Date:Sun，6Feb201118;10;00GM1 Content-Type:applieation/json exampe.distfs.cn 12访问控制列表接口要求 12.1概述 ACL是一种权限控制方式,能够细粒度地控制每个用户或用户组对特定文件或文件夹的访问权 限
一个文件或文件夹的ACI包括一组规则,每一条规则指定了一个特定用户或用户组对该文件或 文件夹的读、写和执行权限
文件夹可以有一组默认的ACL规则,当在此文件夹中创建文件或子文件 夹时,默认ACL规则会被文件或子文件夹继承
ACL的应用接口包括;添加ACL
规则读取ACL修改ACL规则,删除ACL、删除ACL规则和删 除默认ACI规则
AC1接口是可选接口
12.2添加ACL规则 2.2.1功能描述 添加ACL
规则的操作参数为;AddACLRole,用于在分布式文件存储中向文件或文件夹添加一条 ACI规则
2.2.2请求定义 PUT/Account>/Path)?op=addaclroleHTTP/1.1 Hot:[HostName Accept:application/json Content-Type:application/json Authorization;[SignatwreValue] 'xxxxxxxxxxxxxxxx","isdefault" elfalse "aclspec" ':truel 2.2.3请求URL http://example.distfs.cn/
GB/T31916.3一2018 12.2.6请求消息体 请求消息体中各参数描述见表93.
表93请求消息体 选择状态 参数 名称 类型 描述 其格式为“权限类型:用户名或组名可选):;权限字符 串”,这三个部分之间用半角冒号(:)分隔
其中权限类 型可以是user、group,other、mask等,分别表示这条规 则是针对用户的user)、用户组的group)、其他人的 other),或是一种权限的掩码(n 1(mask 用户名或组名 可以不指定,如果指定则对某个特定的用户或用户组的 ACL规则 aelspee string 必选 树 权限进行限制,如果不指定,则默认对文件的所 i者或 其所在用户组的权限进行限制
权限字符串形如 “",“w",“"分别指读、写执行的权限,如果不 指定相应的权限则用短横(-)代替
该参数的一个样例 user:foo:rw-” 规则 是否是默认ACL规则,即能够继承给子文件和子文件 默认ACL isdefault 可选 boolean 标记 夹的规则
默认值;true 12.2.7响应状态码 响应状态码及其描述见表94
表94响应状态码 状态码 描述 200 OK,添加ACI规则成功 nvalidACISpec,ACL规则不符合规范 400 aldRoleType,规则的“是否默认"标记不正确 400 Inval Unahorized,用户没有传人验证信息或验证信息不正确 401 403 Forbhidden,用户没有访问该文件或文件夹的权限 404 NoSuchFile,用户请求的文件或文件夹路径不存在 501 Notlmplemented,服务器不支持此功能接口 12.2.8响应定义 HTTP/1.1200oK Date:date Content-Type:application/json Server:server "RoeID";"xxxxx" 78
GB;/T31916.3一2018 2.2.9响应消息头 按公共响应头定义
12.2.10响应消息体 响应消息体中各参数描述见表95
表95响应消息体 类型 参数 名称 描述 选择状态 roleid ACL规则ID 必选 唯一标识ACL规则的字符串 string 12.2.11 请求和响应示例 请求消息和响应消息见示例
示例 请求消息: PUT/MyAccount/temp?op=setaclHTTP/1.1 Host:example.distfs.cnm Accept;applieation/json 心 ype:application/json Authorization15IUYRRTY876oIU4D aclspec grouP:;r isdefault";alse 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118:10;00GMT Content-Type:applieation/json Server:example.distfs.cn "roleid";"o001" 12.3读取ACL 12.3.1功能描述 读取ACI
的操作参数为;GetACL,用于在分布式文件存储中读取文件或文件夹的所有ACI 规则
2.3.2请求定义 GET/Account>/Path>?op=getaclHTTP/1.1 Host:[HostName Accept:application/json Content-Type;appication/json Athorization:[SgnatureVal lue 2.3.3请求URL http://example.distfs.cn/
GB;/T31916.3一2018 "stickybit'";false 2.3.9响应消息头 按公共响应头定义 12.3.10响应消息体 响应消息体中各参数描述见表97
表97响应消息体 类型 选择状态 参数 名称 描述 aclstatus ACL信息集合 JSON ACL信息的集合 必选 entries ACI规则集合 Js(ON 用字符串表示的ACL规则集合 必选 AcL规则的D roleidl ACI规则ID string 必选 ACL规则描述 NCL规则的描述 必选 rolespec string 是否是默认AcL规则,即能够继承给子文件和子文件 isdefalt 默认规则标记 boolean 必选 夹的规则 必选 用户组名 文件或文件夹的用户组名 group string 属主名 必选 文件或文件夹的属主名 owne1 string permission 权限 文件或文件夹的权限 必选 string 文件或文件夹的防删除位
stiekyBt对于文件不起作 用,对于文件夹,stickyBit为true表示所有的用户都可 防删除位 stickybit boolean 必选 以在这个文件夹下创建文件,但只能删除自己创建的 文件 12.3.11 请求和响应示例 请求消息和响应消息见示例
示例 请求消息: aclHTTP/1. GE:T/MyAccount/emp?op一getn Host:example.distfs.cn Aceept:applieation/json Content-Type:application/jsonm Athorization;15IUYRRTY876oU4D 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118:10,00GMT Content-Type;applieation/jsonm 132 Content-length Server;example.distfs.cn 81
GB/T31916.3一2018 aclstatus 'entries "roleid","o001" "rolespec";"group;;r-x "isdefaul":false group 'supergroup" "hadoop owner "775" permmIssIon 'stickvbit"false 12,4修改ACL规则 12.4.1功能描述 修改ACL规则的操作参数为;ModifyAcLRole,用于在分布式文件存储中修改文件或文件夹的 条AC规则
12.4.2请求定义 PUT/Account>/Path)?op=modifyaclroleHTTP/1.1 Host:[HostName] tion/jsonm Accept:aPplicat Content-Type:appiceation/json reValue Authorization:LSignature "roleid";"xxxx" "xxxxxxxxxxxxxxxx","isdefaul";truelfalse) "aclspec" 12.4.3请求URL http://example.distfs.cn/
GB/T31916.3一2018 12.4.10响应消息体 12.4.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 PUT/MyAccount/ /emp?op=modifyclHTTP/1.l Host:example.distfs.cen application/json Content-Type:appliecation/json Auhoriatom.15UYRRTY87aoUD "roleid";"o001" "aclspec";"user;rwx" "isdefault":false 响应消息 HTTP/1.1200OK Date;Sun，6Feb201118;10;00GMT Content-Type:application/json Server:example.,distfs,en 12.5删除ACL 2.5.1功能描述 删除ACL的操作参数为;RemoveACL,用于在分布式文件存储中删除文件或文件夹的ACL,该接 口删除所有的ACL
规则,但保留基本的文件权限所对应的规则 12.5.2请求定义 DELETE/Account)>/
GB;/T31916.3一2018 2.5.5请求消息参数 2.5.6请求消息体 无 2.5.7响应状态码 响应状态码及其描述见表100. 表100响应状态码 状态码 描述 200 oK,制除AcL成功 401 Unauthorize zed,用户设有传人验证信息或验证信息不正确 403 Forbiden,用户没有访问该文件或文件夹的权限 04 NoSuechFile,用户请求的文件或文件夹路径不存在 501 Notlmplemented,服务器不支持此功能接口 响应定义 12.5.8 HTTP/1.1200OK Date:date Content-Type:application/json Server:server 12.5.9响应消息头 按公共响应头定义
12.5.10响应消息体 无
2.5.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息: DELETE/MyAccount/temp?op=renmoveaclHTTP/1. Host:example.distfs.cn Acecept:application/json Content-Type:application/json Authorization:15IUYRRTY876OIU4D 响应消息: HTTP/1.1200OK ,6Feb201118,l0,00GMT Date:Sun，" 85
GB/T31916.3一2018 Content-Type;applieation/jsonm Server;example.,distfs.,cn 2.6删除ACL规则 12.6.1功能描述 删除ACL规则的操作参数为Re emoveACLRole,用于在分布式文件存储中删除文件或文件夹的一 条ACL规则,保持其他规则不变
12.6.2请求定义 DELETE/Ae ccount nt)/(Path)?op=removeaclroleHTTP/1.1 Host:[HostNan ame Accept:applieation/json Content-Type:application/jsonm Authorizaton;[SignatwreValwe] "roleid""xxxx 2.6.3请求URL http://example.distfs.cn/Account)/Path7 其中:(Ae nt)表示账户ID,(Path)表示文件或文件夹的位置 Account 12.6.4请求消息头 按公共请求头定义
12.6.5请求消息参数 无 12.6.6请求消息体 请求消息体中各参数描述见表101
表101请求消息体 参数 名称 类型 描述 选择状态 ACL规则D 唯一标识AcL规则的字符串 string roleid 必选 12.6.7响应状态码 响应状态码及其描述见表102
表102响应状态码 状态码 描述 200 OK,删除ACI
规则成功 401 Unauthorized,用户没有传人验证信息或验证信息不正确 86
GB;/T31916.3一2018 表102(续 状态码 描述 403 Forbidden,用户没有访问该文件或文件夹的权限 NosuchFle,用户请求的文件或文件夹路径不存在 404 NoSsuehACLRdle,要删除的AcL规则不存在 404 Notlmplemented,服务器不支持此功能接口 501 2.6.8响应定义 HTTP/1.1200OK Date:date Content-Type:application/json Server:server 响应消息头 12.6.9 按公共响应头定义
2.6.10响应消息体 无
12.6.11请求和响应示例 请求消息和响应消息见示例
示例 请求消息: DELETE/MyAecount/temp?op=removeaclroleHTTP/1.1 Host:example.distfs.cn Accept:applieation/json Content-Type:applieation/jsonm Authorization:l5IUYRRTY876OIU4D "roleid";"0001" 响应消息 HTTP/1.1200OK Dte;Sun,6Feb20l118;l0,00GMr Content-Type:application/json le.distfs.cn ServereXamp 2.7删除默认ACL规则 12.7.1功能描述 删除默认ACL规则的操作参数为;RemoveDefaultACL,用于在分布式文件存储中删除文件或文 件夹的默认ACL规则,该接口删除所有的默认ACL规则即能够继承给子文件和子文件夹的规则)， 但保留用户设置的其他ACL
规则
心
GB/T31916.3一2018 12.7.2请求定义 DELETE/Account>/Path)?op=removedefaultaclHTTP/1.1 Host:[HosIName] Accept:applieation/json Content-Type:applieation/json reValuue [sSgnatiur Authorization: 12.7.3请求URL //example.distfs.cn/Account〉/《Path>/ htp: 其中:(Aecount)表示账户ID,(Path)表示文件或文件夹的位置
12.7.4请求消息头 按公共请求头定义 12.7.5请求消息参数 无
12.7.6请求消息体 12.7.7响应状态码 响应状态码及其描述见表103
表103响应状态码 状态码 描述 200 OK,删除默认ACI
成功 401 Unauthorized,用户没有传人验证信息或验证信息不正确 Forbidden,用户没有访问该文件或文件夹的权限 403 NoSuchFile,用户请求的文件或文件火路径不存在 404 501 Notlmplemented,服务器不支持此功能接口 12.7.8响应定义 HTTP/1.1200O)K Date:date Content-Type:application/json Server:server 12.7.9响应消息头 按公共响应头定义
88
GB;/T31916.3一2018 12.7.10响应消息体 12.7.11请求和响应示例 请求消息和响应消息见示例
示例: 请求消息 DELETE/MyAccount/temp?op=removedefaultaclHTTP/1.l Host:example.distfs.cn AAccept:applieation/json Content-Type:applieation/jsonm Authorization;15IUYRRTY876oU4D 响应消息: HTTP/1.1200OK Date:Sun，6Feb201118:10;00GMT onen-Type，aphieaiom/jison Server;example.,distfs,cn s9
GB/T31916.3一2018 附 录 规范性附录 分布式文件存储管理接口 A.1概述 附录A中的分布式文件存储管理接口是系统管理员为了维护系统而使用的接口
不同于正文中 提供给外部应用使用的接口,管理接口提供给系统管理员用于系统内部维护
本附录中的管理接口包 括系统管理、负载均衡策略管理和存储节点管理的相关接口,每个接口定义仅给出功能描述、请求定义 和响应状态码的定义,供用户参考
A.2系统管理接口 A.2.1概述 分布式文件存储管理接口包括设置/查询最低文件副本数,设置/查询最大文件大小,文件副本查 询、检查修复文件系统、查询用户资源、查询系统基本信息、查询节点硬件状态,查询报警,导出报警
A.2.2设置/查询最低文件副本数 A.2.2.1功能描述 主流的分布式文件存储都采用文件副本的机制即将一个文件的多个副本存储在不同的存储服务 器中,当某些存储服务器失效后该文件还有另外的副本可用
最低文件副本数是针对整个系统而言,是 为了保证整个文件系统的可靠性所需要设置的文件的最少的副本数
设置/查询最低文件副本数的操 作参数为:ChMinRepNum,用于在分布式文件存储中设置/查询最低文件副本数
当用户将最低文件 副本数调高,可能会导致某些文件的副本数不再满足要求
此时系统会自动检查修复文件系统,添加文 件副本以满足最低要求(参看“检查修复文件系统”接口)
同时修改文件属性中的文件副本数(参看“修 改文件属性"接口)
同时应生成一条副本数量的报警信息
A.2.2.2请求定义 GET/Account)?op=ehminrepnum[&nminrepnum=xxx]HTTP/1.1 请求消息参数见表A.1
表A.1 请求消息参数 参数 名称 类型 描述 选择状态 若请求中提供该参数,表示设置最低文件副本数(一个 最低文件副本数 int 大于0,小于或等于512的整数)
若未提供该参数,表 可选 mInrepnum 示查询最低文件副本数 A.2.2.3响应状态码 响应状态码及其描述见表A.2
90
GB;/T31916.3一2018 表A.2响应状态码 状态码 描述 oK,成功设置或查询最低文件副本数 200 400 nvalidReplicationNumber,请求参数不是整数或在1512的范围之外 401 Jnauthorized,用户没有传人验证信息或验证信息不正确 501 Notlmplemented,服务器不支持此功能接口 A.2.3设置/查询最大文件大小 A.2.3.1功能描述 系统上传文件时,单个文件的大小有一定的眼制
设置/查询最大文件大小的操作参数为:ChMax FileSize,用于设置或查询最大文件大小
A.2.3.2请求定义 4maxfilesize=xxxHTTP/1.1 GETAecount)? op=chmaxfilesize[&. 请求消息参数见表A.3
表A.3请求消息参数 类型 选择状态 参数 名称 描述 以Byte为单位的正整数
若请求中提供该参数,表示 最大文件大小 设置最大文件大小
若未提供该参数,表示查询最大文 可选 maxilesize long 件大小 A.2.3.3响应状态码 响应状态码及其描述见表A.4
表A.4响应状态码 状态码 描述 200 OK,设置或查询系统最大文件大小成功 400 InvalidFileSize,请求参数不是整数 401 Unauthorized,用户没有传人验证信息或验证信息不正确 otImplemented,服务器不支持此功能接口 501 A.2.4文件副本查询 A.2.4.1功能描述 文件副本查询的操作参数为:QueryFaRep用于查询某文件的各个副本的位置 A.2.4.2请求定义 GET/Account)/(Path)?op=queryfilerepHTTP/1.1 91
GB/T31916.3一2018 A.2.4.3响应状态码 响应状态码及其描述见表A.5
表A.5响应状态码 状态码 描述 OK,查询文件副本成功 200 400 Inva validFileName,指定的文件名不符合文件命名规则 401 Unauthorized,用户没有传人验证信息或验证信息不正确 NoSuehFile,请求的文件未找到 404 501 NotImplemented,服务器不支持此功能接口 A.2.5检查修复文件系统 A.2.5.1功能描述 检查修复文件系统的操作参数为:FSCK,用于检查和修复文件系统中的错误,包括检查损坏的文 件以及文件的副本数量是否达到要求,并尝试修复
可以检查整个文件系统或文件系统的一部分 A.2.5.2请求定义 1tfile= PT/Account)/(Path)?op=fsck[&.output -xxxHTTP/1.1 请求消息参数见表A.6. 表A.6请求消息参数 参数 名称 类型 选择状态 描述 指定将检查报告写人特定的文件
包括绝对路径和文 件名,其名称应符合6.2中所述的文件命名规则
若请 outputfile 报告文件名 可选 string 求中提供该参数,表示输出报告至文件
若未提供该参 数,则在系统日志中输出报告 A.2.5.3响应状态码 响应状态码及其描述见表A.7
表A.7响应状态码 状态码 描述 200 OK,检查修复文件系统成功 400 InvalidFolderName,指定的修复路径不符合命名规则 hnvaliadFileName,指定的导出文件路径不符合命名规则 400 ,用户没有传人验证信息或验证信息不正确 401l Unauthorized 500 nternalsererEror,检查修复文件系统失败 501 Notlmpemented,服务器不支持此功能接口 92
GB;/T31916.3一2018 A.2.6查询用户资源 A.2.6.1功能描述 查询用户资源的操作参数为:QueryUserRe Resource,用于在分布式文件存储中查询用户的资源,包 括文件夹数量、文件数量、总的磁盘容量及总1/0数等
A.2.6.2请求定义 GET/Aecount)?op=queryuserresourceHTTP/1.1 A.2.6.3响应状态码 响应状态码及其描述见表A.8
表A.8响应状态码 状态码 描述 200 OK,查询用户资鄙成功 心 401 nauthoriz zed,用户没有传人验证信息或验证信息不正确 501 NotImplemented,服务器不支持此功能接口 查询系统基本信息 A.2.7.1功能描述 查询系统基本信息的操作参数为:QuerySystemlnfo,用于查询系统基本信息 A.2.7.2请求定义 GET/Account)?op=querysysteminfoHTTP/1.1 A.2.7.3响应状态码 响应状态码及其描述见表A.9
表A.9响应状态码 描述 状态码 oK,查询系统基本信息成功 200 401 Unauthorized,用户没有传人验证信息或验证信息不正确 Notlmpemented,服务器不支持此功能接口 501 A.2.8查询节点硬件状态 A.2.8.1功能描述 查询节点硬件状态的操作参数为:QueryNodeHwState.,用于查询节点硬件状态
若某些节点暂时 无法连接,仍返回成功,返回可连接节点的硬件状态信息列表
生成相应的节点断线报警
若节点的硬 93
GB/T31916.3一2018 件资源使用率超过设定阀值,则生成节点硬件报警
A.2.8.2请求定义 GET/
GB/T31916.3一2018 A.2.10.3响应状态码 响应状态码及其描述见表A.15. 表A.15响应状态码 状态码 描述 200 OK,导出报警成功 400 lnvalidDate,起始时间或终止时间的格式不对 400 lnvalidDateRange,终止时间早于起始时间 400 nvalidFileName,指定的导出文件名称不符合命名规则 40l Unauthorized,用户没有传人验证信息或验证信息不正确 501 NotImpemented,服务器不支持此功能接口 负载均衡策略接口 A.3.1概述 负载均衡是分布式文件存储的一个重要特性,它是指系统中所有存储服务器的存储空间使用率基 本相等
负载均衡策略接口包括创建均衡策略、删除均衡策略、查询均衡策略、修改均衡策略、启用均衡 策略和停用均衡策略
A.3.2创建均衡策略 A.3.2.1功能描述 创建均衡策略的操作参数为:CreateLBPoliey,用于创建负载均衡策略
A.3.2.2请求定义 PUTAccount)?op=ereatelbpoieyHTTP/1.l "policyname":"xxxxxx "polieyfile";"xxxxxx "policyenabled":truelfalse 请求消息体中各参数描述见表A.l6
表A.16请求消息体 参数 名称 类型 描述 选择状态 只能包括字母、数字、下划线(_、短横(-),应以字母或 策略名称 必选 policyname string 数字开头,长度不超过256个字节 包括文件的绝对路径和文件名
其名称应符合6.2中 polieyfile 配置文件 必选 string 所述的文件命名规则 polieyenabled启用标记 boolean 布尔值,true表示启用,false表示不启用
默认值;false 可选 96
GB;/T31916.3一2018 A.3.2.3响应状态码 响应状态码及其描述见表A.17
表A.17响应状态码 状态码 描述 200 OK,创建负载均衡策略成功 hiaRieN ,策略名称不符合命名规则 400 Inval Name， nvalidPolieyEnabled,策略启用标记不符合规范 400 nvalidFileName,配置文件名不符合规范 400 01 ,用户没有传人验证信息或验证信息不正确 Unauthorized NoSucehFile,配置文件不存在 404 501 Notlmplemented,服务器不支持此功能接口 A.3.3删除均衡策略 A.3.3.1功能描述 删除均衡策略的操作参数为;DeleteLBPolicy,用于删除负载均衡策略 A.3.3.2请求定义 DELETE/Account)?op=deletelbpoliey&polieyid=xxxHTTP/1.1 请求消息参数见表A.18
表A.18请求消息参数 参数 名称 类型 描述 选择状态 polieyid 策略ID 唯一标识负载均衡策略的字符串 必选 string A.3.3.3响应状态码 响应状态码及其描述见表A.19
表A.19响应状态码 状态码 描述 200 OK,删除负载均衡策略成功 Unauthorized,用户没有传人验证信息或验证信息不正确 401 404 NoSuchPolicy,指定的策略不存在 501 Notlmplemented,服务器不支持此功能接口 97
GB/T31916.3一2018 A.3.4查询均衡策略 A.3.4.1功能描述 查询均衡策略的操作参数为:QueryLBPoliey,用于查询负载均衡策略
A.3.4.2请求定义 -queryllpoliesy[&polieyid=xx][&polieymamc- GET/〈Account)?op= =xxx [&policyenabled=truelfalse]HTTP/1.1 请求消息参数见表A.20. 表A.20请求消息参数 参数 名称 类型 描述 选择状态 唯一标识负载均衡策略的字符串
若请求中抛供该参 polieyid 策略ID string 数,表示查询特定ID的均衡策略
若未提供该参数,查 可选 询所有的均衡策略 只能包括字母,数字、下划线(_),短横(-),应以字母或 数字开头,长度不超过256个字节
若请求中提供该参 policvname 策略名称 string 可选 数,表示查询特定名称的均衡策略
若未提供该参数 查询所有的均衡策略 布尔值,true表示已启用,false表示未启用
若请求中 polieyenabled启用标记 提供该参数,表示查询特定启用状态的均衡策略
若未 可选 boolean 提供该参数,查询所有状态的均衡策略 A.3.4.3响应状态码 响应状态码及其描述见表A.21
表A.21响应状态码 状态码 描述 oK,查询负载均衡策略成功 200 nmaldlwie" 400 Name， ,策略名称不符合规范 401 Unauthorize ed,用户没有传人验证信息或验证信息不正确 404 NoSuchPoliey,不存在符合条件的均衡策略 NotImpemented,服务器不支持此功能接口 501 A.3.5修改均衡策略 A.3.5.1功能描述 修改均衡策略的操作参数为:EditLBPoiey,用于修改负载均衡策略 A.3.5.2请求定义 PUTAccount)?op=editlbpolieyHTTP/1.1 98
GB;/T31916.3一2018 "polieyid""xxx" XXXxXx "poliegymame" "polieyfile""xxxxx" 请求消息体中各参数描述见表A.22 表A.22请求消息体 参数 名称 类型 描述 选择状态 策略ID 必选 唯一标识负载均衡策略的字符串 policyid string 只能包括字母、数字、下划线(_)短横(-),应以字母或 polieyname 策略名称 string 可选 数字开头,长度不超过256个字节
默认值.原名称 包括文件的绝对路径和文件名
其名称应符合6.2中 polieyfile配置文件 可选 string 所述的文件命名规则
默认值;原配置文件路径 A.3.5.3响应状态码 响应状态码及其描述见表A.23
表A.23响应状态码 状态码 描述 oK,修改负载均衡策略成功 200 nvalidPolieyName,策略名称不符合命名规则 400 00 nvalidFileName,配置文件名不符合规范 Unathorized,用户没有传人验证信息或验证信息不正确 40l 404 NoSuchPoliey,指定的策略不存在 404 NoSuchFile,配置文件不存在 501 Notlmplemented,服务器不支持此功能接口 A.3.6启用均衡策略 A.3.6.1功能描述 启用均衡策略的操作参数为;EnableLBPoliey,用于启用负载均衡策略
A.3.6.2请求定义 PUT/Account)?op=enablelbpoliey&.polieyid=xxxHTTP/1.1 请求消息参数见表A.24
99
GB/T31916.3一2018 表A.24请求消息参数 参数 名称 类型 描述 选择状态 唯一标识负载均衡策略的字符串 polieyid 策略lD string 必选 A.3.6.3响应状态码 响应状态码及其描述见表A.25
表A.25响应状态码 描述 状态码 200 OK,启用负载均衡策略成功 PolieyAreadyEnabled,该策略已经启用 400 401 Unauthorized,用户没有传人验证信息或验证信息不正确 ehPoiey,指定的策略不存在 404 NoSuch NotImplemented,服务器不支持此功能接口 501 A.3.7停用均衡策略 A.3.7.1功能描述 停用均衡策略的操作参数为:DisableLBPolicy,用于停用负载均衡策略
A.3.7.2请求定义 PUT/Account)?op=disablelbpoliey&.polieyid=xxxHTTP/1. 请求消息参数见表A.26
表A.26请求消息参数 参数 名称 类型 描述 选择状态 唯一标识负载均衡策略的字符串 polieyid 策略lD string 必选 A.3.7.3响应状态码 响应状态码及其描述见表A.27
表A.27响应状态码 描述 状态码 200 O)K,停用负载均衡策略成功 400 PolicyAreadyDisabled,该策略已经停用 Unauthorized,用户没有传人验证信息或验证信息不正确 401 404 NoSuchPoliey,策略ID不存在 50l Notlmplemented,服务器不支持此功能接口 100
GB;/T31916.3一2018 A.4节点操作 A.4.1概述 分布式文件存储中,节点的操作包括添加、删除启用、停用元数据节点或存储节点以及节点的查 询、数据迁移
A.4.2添加节点 A.4.2.1功能描述 添加节点的操作参数为:AddNode,用于添加节点
A.4.2.2请求定义 PUT/Account)?op=addnodeHTTP/1.1 "nodename";"xxxxxx" "nodeyype":0l1. 'nodeip";"Xx.xx.Xx.xx" "nodleembled" ,truefalse 请求消息体中各参数描述见表A.28
表A.28请求消息体 参数 名称 类型 描述 选择状态 只能包括字母,数字,下划线(_),短横(-),应以字母或 节点名称 nodename string 必选 数字开头,长度不超过256个字节 nodetype 整数,0代表元数据节点,l代表存储节点 节点类型 int 必选 节点 节点的IP地址,可以是IPv4或IP6 nodeip string 必选 布尔值,true表示启用该节点,falee表示不启用
默认 nodeenabled启用标记 boolean 可选 值:true A.4.2.3响应状态码 响应状态码及其描述见表A.29
表A.29响应状态码 状态码 描述 200 OK,添加节点成功 00 nvalidNodeName,节点名称不符合命名规则 400 InvalidNodeType,节点类型是除0和1以外的字符 400 lnvalidNodeIP,节点IP的格式错误 01
GB/T31916.3一2018 表A.29(续 状态码 描述 Unauthorized,用户没有传人验证信息或验证信息不正确 40l NodeUnavailable,节点IP无法访问 404 409 NodeAlreadyExists,节点已存在 501 NotImpemented,服务器不支持此功能接口 A.4.3删除节点 A.4.3.1功能描述 删除节点的操作参数为DeleteNode,用于删除节点
删除存储节点后可能造成部分文件副本数不 足,此时应自动调用“检查文件系统”接口,恢复文件副本数量为用户设定的副本数量
同时应生成一条 副本数量的报警信息
删除元数据节点后该节点存储的元数据会转储到其他元数据节点上
A.4.3.2请求定义 DELETE/Account)?”op=deletenode&.nodeid=xxxHTTP/1.1 请求消息参数见表A.30
表A.30请求消息参数 参数 名称 类型 描述 选择状态 nodeid 节点ID string 唯一标识节点的字符串 必选 A.4.3.3响应状态码 响应状态码及其描述见表A.31
表A.31响应状态码 状态码 描述 200 OK,删除节点成功 401 Unauthorized,用户没有传人验证信息或验证信息不正确 NoSuchNode,指定的节点不存在 404 405 CannotDleteNode,该节点为仅存的启用的元数据节点或存储节点,删除将导致系统无法正常运行 501l Notlmplemented,服务器不支持此功能接口 A.4.4启用节点 A.4.4.1功能描述 启用节点的操作参数为:EnableNode,用于启用节点
102
GB;/T31916.3一2018 A.4.4.2请求定义 =enablenode&.nodeid=xxxHTTP/1.l1 PUT/Account)?op= 请求消息参数见表A.32
表A.32请求消息参数 参数 名称 类型 描述 选择状态 节点D 唯一标识节点的字符串 必选 nodeid string A.4.4.3响应状态码 响应状态码及其描述见表A.33
表A.33响应状态码 状态码 描述 OK,启用节点成功 200 NodeAlreadyEnabled,该节点已经启用 400 401 Unauthorized,用户没有传人验证信息或验证信息不正确 NoSuchNode,指定的节点不存在 404 501 Notlmplemented,服务器不支持此功能接口 A.4.5停用节点 A.4.5.1功能描述 停用节点的操作参数为;DisableNode,用于停用节点
停用存储节点后可能造成部分文件副本数 不足,此时应自动调用“检查文件系统”接口,恢复文件副本数量为用户设定的副本数量
同时应生成 条副本数量的报警信息
停用元数据节点后该节点存储的元数据会转储到其他元数据节点上
A.4.5.2请求定义 PUTAccount>?op=disablenode&.nodeid=xxxHTTP/1.1 请求消息参数见表A.34
表A34请求消息参数 参数 名称 类型 描述 选择状态 nodeid 节点ID string 唯一标识节点的字符串 必选 A.4.5.3响应状态码 响应状态码及其描述见表A.35
03
GB/T31916.3一2018 表A.35响应状态码 状态码 描述 200 OK,停用节点成功 400 NodeAlreadyDisabled,该节点已经停用 Unauthorized,用户没有传人验证信息或验证信息不正确 401 NoSuchNode,指定的节点不存在 404 501 Notlmplemented,服务器不支持此功能接口 A.4.6查询节点 A.4.6.1功能描述 查询节点的操作参数为:QueryNode,用于查询节点信息
A.4.6.2请求定义 GET/Account)?op=querynodeHTTP/1.1 "nodeid";"xxxx" nodename":"xxxxxx nodetype":01， nodeip""xx.xx.xx.xx" "nodeenabled",truelfalse 请求消息体中各参数描述见表A.36
表A.36请求消息体 参数 名称 类型 描述 选择状态 唯一标识节点的字符串
若请求中提供该参数,表示查 节点D nodeid 可选 string 询特定ID的节点
若未提供该参数,查询所有的节点 只能包括字母,数字、下划线(_),短横(-),应以字母或 数字开头,长度不超过256个字节
若请求中提供该参 节点名称 可选 nodename string 数,表示查询特定名称的节点
若未提供该参数,查询 所有的节点 整数,0代表元数据节点,1代表存储节点
若请求中提 节点类型 供该参数,表示查询特定类型的节点
若未提供该参 可选 nodetpe int 数,查询所有类型的节点 节点的IP地址,可以是IPv4或IPv6
若请求中提供该 节点IP 参数,表示查询特定P的节点
若未提供该参数,查询 可选 nodeip string 所有的节点 布尔值true表示启用该节点,false表示不启用，若请 nodenabled启用标记 求中提供该参数,表示查询特定启用状态的节点
若末 可选 boolean 提供该参数,查询所有状态的节点 104
GB;/T31916.3一2018 A.4.6.3响应状态码 响应状态码及其描述见表A.37
表A.37响应状态码 状态码 描述 OK,查询节点成功 200 400 InvalidNodeNat Name,节点名称不符合规范 400 lInvalidNodeType,节点类型是除0和1以外的字符 validNdelP,节点IP的格式错误 400 Inva 401 Unauthorized,用户没有传人验证信息或验证信息不正确 404 NosuehNode,不存在符合条件的节点 501 Notlmplemented,服务器不支持此功能接口 A.4.7迁移节点数据 .4.7.1功能描述 迁移节点数据的操作参数为:MigrateNodeData,用于将一个节点上的所有数据迁移到另一个节 点
两个节点的类型须相同即都是元数据节点或都是存储节点. A.4.7.2请求定义 PUT/(Account)>?op=migratenodedata&.srenodeid=xxx&.destnodeid=xxxHTTP/1. 请求消息参数见表A.38
表A.38请求消息参数 选择状态 参数 名称 类型 描述 源节点D 一标识源节点的字符串 必选 srenodeid 唯一 string destnodeid 目的节点D 目的节点的ID,唯一标识目的节点的字符串 必选 string A.4.7.3响应状态码 响应状态码及其描述见表A.39
表A.39响应状态码 状态码 描述 200 OK,迁移节点数据成功 Unauthorizwd,用户没有传人验证信息或验证信息不正确 401 404 NoSsuchNode,源节点D或目的节点D不存在 eData,源节点与目的节点的类型不同 405 Cannot wnMerT 501 Notlmplemented,服务器不支持此功能接口 05
GB/T31916.3一2018 录 附 B 规范性附录) 补充出错信息 分布式文件存储对HTTP状态码的补充出错信息描述见表B.1
表B.1补充出错信息描述 状态码 误信息 描述 lnvalidFileName 文件名不符合命名规则 nvalidFolderName 文件夹名不符合命名规则 nvalidFileSize |用户请求创建文件大小大于系统设定的最大文件大小值 InvalidPermission |用户请求修改的文件权限参数不正确 nvalidReplicationNumber 用户请求修改的文件副本数不正确 用户请求修改的回收站保存时间不正确 InvalidTrashTime 下载时传输范围不在文件大小范围内 nvalidRange InvalidOffset 读写文件的起始位置不合理 读写文件的长度不合理 Invalidl.ength nvalidXAttrName 扩展属性名称不符合命名规则 扩展属性的编码不正确 InvalidEncoding lnvalidSnapshotName 快照名称不符合命名规则 ACL规则的表示不符合命名规则 lnvalidACISpec 400 lnvaldRoleType 规则的“是否默认"标记不正确 lnvalidNodeName 节点名称不符合命名规则 hlNwdTy 节点类型不符合命名规则 InvalidNodeIP 节点IP地址不符合命名规则 nvalidNodeEnabled 节点启用标记不符合命名规则 NodeAlreadyEnabled 启用已经启用的节点 停用已经停用的节点 INodeAIreadyDisabled lnvalidDate 时间的格式不正确 时间的范围不正确 InvalidDateRange nvalidPolieyName 负载均衡策略的名称不符合命名规则 |InvalidPolieyEnabled 负载均衡策略的启用标记不符合命名规则 PolicyAlreadyEnabled 启用已经启用的负载均衡策略 PolieyAlreadyDisabled 停用已经停用的负载均衡策略 106
GB;/T31916.3一2018 表B.1续) 状态码 错误信息 描述 请求的文件不存在 NoSuchFile NoSuchFolder 请求的文件夹不存在 NoSuchXattr 请求的扩展属性不存在 NoSuchSnapshot 请求的快照不存在 404 NoSuchACLRule 请求的ACL规则不存在 NoSuchPoliey 请求的负载均衡策略不存在 请求的节点不存在 INoSuchNode NodeUnavailable 节点无法连接 无法删除仅存的元数据节点或存储节点 CannotDeleteNode 405 CannotMigrateData 无法迁移节点数据 FileAlreadyExists |用户创建的文件名与已有文件重名 FolderAlreadyExists 用户创建的文件夹名与已有文件夹重名 409 FolderNotEmpty 用户请求删除一个不为空的文件夹 用户创建的扩展属性与已有属性重名 XattrAlreadyExists 用户添加的节点已经在集群中 NodeAlreadyExists 07
信息技术云数据存储和管理第3部分：分布式文件存储应用接口GB/T31916.3-2018
随着互联网技术的不断发展，越来越多的数据被生成、存储和传输。在如此海量的数据中，如何高效地存储和管理数据成为了热门话题。分布式文件存储应用接口GB/T31916.3-2018正是为解决这一问题而生。
什么是分布式文件存储应用接口？
分布式文件存储应用接口（以下简称FSAPI）是指通过网络对分布式文件存储系统进行访问和操作的接口。它是一组标准化的接口规范，可以使得应用程序在不同的分布式文件存储系统上获取相同的服务和功能，从而实现数据的共享和交换。
FSAPI的特点
- 可移植性：FSAPI作为一组接口规范，能够使得应用程序在不同的分布式文件存储系统上获取相同的服务和功能。
- 易使用性：FSAPI可以简化对分布式文件存储系统的访问和操作过程，使得应用程序开发者可以更加专注于业务逻辑的实现。
- 高可靠性：分布式文件存储系统采用分布式架构，具有数据冗余备份和容错机制，可以保证数据的安全性和可靠性。
FSAPI的应用场景
FSAPI广泛应用于云存储、大数据处理、物联网等领域。例如，在云存储中，企业可以通过FSAPI将其私有云存储与公有云存储进行集成；在大数据处理中，FSAPI可以帮助应用程序更加高效地读取、写入和管理海量数据；在物联网中，FSAPI则可以实现设备之间的数据共享和交换，从而提高系统的智能化程度。
总结
通过本文的介绍，我们了解到分布式文件存储应用接口GB/T31916.3-2018的相关内容。它作为一组标准化的接口规范，可以使得应用程序在不同的分布式文件存储系统上获取相同的服务和功能，从而实现数据的共享和交换。FSAPI在云存储、大数据处理、物联网等领域应用广泛，具有可移植性、易使用性和高可靠性的特点。
