云服务器内容精选

  • 响应示例 状态码: 200 返回查询到文件列表 { "category" : "drive#fileList", "nextCursor" : "0|[9-1-0,11-0-1][JzIwMjMtMTItMTNUMDM6MzA6NTkuNTU4Wic=,J0ZpQk02VHhsS2JiSEx4LW54X3FaT2M1bFJBZXEwU0xZeCc=]", "searchCompleted" : false, "files" : [ { "id" : "Fk0n_I_3nVynIIlxGSUdLkYILxIZQ5Yyp", "fileName" : "AI测试-勿删", "mimeType" : "application/vnd.huawei-apps.folder", "fileSuffix" : "", "recycled" : false, "parentFolder" : [ "DEUI7pa0C24ArootIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" ], "containers" : [ "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" ], "properties" : { "srcFileId" : "Fuyt9uELO9mny6vLWnWpIDqppRh3vzC3p", "createUser" : "369528171409614001", "lastEditUser" : "369528171409614001" }, "owners" : [ { "category" : "drive#user", "me" : true, "permissionId" : "1243622029865966464", "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng", "displayName" : "租户管理员" } ], "lastEditor" : { "category" : "drive#user", "me" : true, "permissionId" : "1243622029865966464", "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng", "displayName" : "租户管理员" }, "fileType" : "10", "createdTime" : "2023-12-11T09:17:25.529Z", "editedTime" : "2023-12-11T09:17:25.529Z", "favorite" : false } ], "code" : 0, "msg" : "成功" }
  • URI POST /koodrive/ose/v1/files/{groupId}/{type} 表1 路径参数 参数 是否必选 参数类型 描述 groupId 是 String 团队id type 是 String 类型 0:团队空间 1:团队回收站 表2 Query参数 参数 是否必选 参数类型 描述 team_type 否 Integer 团队类型。非必填参数。 未携带时,默认值为0。 0:部门; 2:群组;
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表4 请求Body参数 参数 是否必选 参数类型 描述 pageInfo 否 PageInfo object 分页信息 sortInfo 否 FileSortInfo object 分类信息 containerId 是 String 空间标识 parentFileId 是 String 文件父目录,枚举值: root:普通文件系统根目录 sbox:保险箱文件系统根目录 fileType 否 String 文件类型 10:文件夹 15:图片 20:视频 26:word 27:excel 28:ppt 30:音频 35:压缩文件 40:应用 45:其他 imageProcess 否 String 图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 表5 PageInfo 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页文件数量,默认100 pageCursor 否 String 分页起始游标 表6 FileSortInfo 参数 是否必选 参数类型 描述 sortType 否 Integer 排序字段 1:文件名排序 2:文件大小排序 3:创建时间排序 4:修改时间排序 5:回收时间(只针对于回收文件) 6:文件格式排序 sortDirection 否 Integer 排序顺序 1:升序 2:降序
  • 请求示例 查看团队空间IAAB_BRGQ-MajA2WAf81df00a3443452aa3dd54e35245bc根目录下的文件列表。 POST /koodrive/ose/v1/files/1269529595850261633/0 Authorization:Bearer+10f88*********4791e9ff { "pageInfo": { "pageSize": "10", "pageCursor": "" }, "sortInfo": { "sortType": "", "sortDirection": "" }, "containerId": "IAAB_BRGQ-MajA2WAf81df00a3443452aa3dd54e35245bc", "parentFileId": "root", "fileType": "", "fileName": "" }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 code Integer 响应码,成功返回0,失败返回错误码 msg String 成功、错误信息 files Array of files objects 搜索结果 total Integer 总数 nextPageCursor String 下一页起始游标,最后一页值为空 表7 files 参数 参数类型 描述 id String 文件id fileSuffix String 文件后缀 fileName String 文件名 fileType String 文件类型 size String 文件大小 updateTime String 最后更新时间 namePath String 名称全路径 idPath String id全路径 downloadLinks Array of downLoadLinks objects 图片类型返回,缩略图地址 teamName String 团队空间返回,部门名称或者群组空间名称 teamId String 群组id,即部门的id或者群组的id containerId String 空间id containerType String 0:部门空间,1:个人空间,2:群组空间 favorite Boolean 个人空间、团队空间返回文件是否被当前用户收藏 owner String 团队空间返回owner名称 表8 downLoadLinks 参数 参数类型 描述 usage String 用途,thumbnail缩略图,content内容 downloadLink String 图片地址
  • 响应示例 状态码: 200 搜索结果 { "code" : 0, "msg" : "success", "files" : [ { "id" : "Abc", "fileName" : "Abc", "fileType" : "1", "size" : "1024", "updateTime" : "2023-05-26T02:08:53.683Z", "namePath" : "", "downloadLinks" : "", "deptName" : "" } ], "total" : 1000 }
  • 请求示例 搜索文件请求示例。 POST /koodrive/ose/v1/files/search Authorization:Bearer+10f88*********4791e9ff { "searchType" : " personal/team", "pageInfo" : { "pageSize" : 100, "pageCursor" : 1 }, "filter" : { "keyWord" : "材料", "containerId" : "123456", "parentFolder" : "1", "fileType" : "1", "sizeRang" : "1024,2048", "updateTimeRange" : "2023-11-02,2023-11-21", "ownerId" : "归属用户id" } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 消息日志跟踪标识(必须58位) Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-User-Id 是 String 用户id,用于app鉴权 X-Date 是 String 日期,用于app鉴权 Host 是 String 地址,用于app鉴权 language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 searchType 是 String 查询类型 personal:个人空间 team:团队空间 pageInfo 是 pageInfo object 分页信息 filter 否 filter object 过滤器 sortInfo 否 sortInfo object 排序信息 recycled 否 Boolean 是否查询回收站,不传默认false 枚举值: true:查回收站文件 false:查对应空间非回收站 recursived 否 Boolean 是否递归查询子目录文件,默认false imageProcess 否 String 图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 表3 pageInfo 参数 是否必选 参数类型 描述 pageSize 是 Integer 每页大小,取值范围[1,100] pageCursor 是 String 起始游标,为空时从第一页开始查询 表4 filter 参数 是否必选 参数类型 描述 keyWord 否 String 文件名称,模糊匹配,最长80个字符 containerId 否 String 空间id,指定父目录时必传 parentFolder 否 String 父目录 fileType 否 String 文件类型,枚举值 /** * 文件夹 / FOLDER("10"), /* * 图片 / PICTURE("15"), /* * 视频 / VIDEO("20"), /* * word / WORD("26"), /* * excel / EXCEL("27"), /* * ppt / PPT("28"), /* * 音频 / AUDIO("30"), /* * 压缩文件 / ARCHIVE("35"), /* * 应用 / APPLICATION("40"), /* * 其他 */ OTHER("45"); updateTimeRange 否 String 最后更新时间区间 ownerId 否 String 文件所有者 表5 sortInfo 参数 是否必选 参数类型 描述 sortType 否 String 枚举类型: fileName:文件名 size:文件大小 type:文件格式 updateTime:最后更新时间 createTime:创建时间 recycledTime:删除时间 fileSuffix:文件格式小类 sortDirection 否 String 枚举类型: desc:降序 asc:升序列
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "relatedToMeInfos" : [ { "operator" : "string", "operateType" : 0, "operateTime" : "2024-06-03T02:25:41.085Z", "id" : "string", "displayName" : "string", "files" : [ { "id" : "string", "size" : "string", "fileType" : "string", "downloadLinks" : [ { "usage" : "string", "downloadLink" : "string" } ], "recycled" : true } ], "expireTime" : "2024-06-03T02:25:41.085Z", "status" : 0, "operatorId" : "string", "containerId" : "string", "tenantId" : "string" } ], "total" : 0 }
  • 请求示例 查询与我有关的文件列表。 GET /koodrive/ose/v1/related?sortType=1&sortDirection=2&pageSize=2&pageCursor=&displayName=&relatedType=1 { "total" : 1, "relatedToMeInfos" : [ { "id" : "1427677119873431808", "operator" : "zujian1", "operatorId" : "1395664261493231745", "operateType" : 1, "operateTime" : "2024-05-23T11:39:35.000Z", "displayName" : "内容未审核.docx", "files" : [ { "id" : "Fv54zG8ha44HX2XRlrQlM76zD4KAN2uOB", "size" : 50383, "fileType" : "26", "recycled" : false, "downloadLinks" : [ { "usage" : "content", "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/6957916206ce4407ac9436567b14d719086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%2586%2585%25E5%25AE%25B9%25E6%259C%25AA%25E5%25AE%25A1%25E6%25A0%25B8.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240523T113937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240523%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e130a202a80157e63583bd7597452eb1d30a70c610db86be68717541114e2bd0" }, { "usage" : "thumbnail", "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/6957916206ce4407ac9436567b14d719086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%2586%2585%25E5%25AE%25B9%25E6%259C%25AA%25E5%25AE%25A1%25E6%25A0%25B8.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240523T113937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240523%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e78515818612dbb024bf14300bd63bbb340e7f7476b988143089ce6d92d6d9f9" } ] } ], "expireTime" : "2024-05-30T11:39:35.000Z", "status" : 0, "containerId" : "IAAFfyRNd07vFgAAA1395504262720721025", "tenantId" : "d5ac574bd2934a69baa4f23c55daa8d4" } ], "code" : 0, "msg" : "成功" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Traceid 否 String 业务跟踪id(必须58位) Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语
  • URI GET /koodrive/ose/v1/related 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数,默认是100,可接受值最大值是100。注意在到达最后的列表之前,实际有可能返回部分或者空结果 pageCursor 否 String 当前页游标,由前一个响应的nextCursor获取,默认为0 sortType 否 Integer 排序类型,1:相关操作时间(默认) sortDirection 否 Integer 排序方向,1:升序,2:降序(默认) displayName 否 String 支持按照展示名称模糊匹配 relatedType 否 String 相关类型 0:所有 1、分享给我的,空和0表示查所有类型 imageProcess 否 String 图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标,如果不存在,代表已返回最后一个 relatedToMeInfos Array of RelatedToMeRecord objects 分享链接列表 total Long 总数 表4 RelatedToMeRecord 参数 参数类型 描述 operator String 操作员名称 operateType Integer 操作类型;1:分享 operateTime String 操作时间 id String 记录id,操作类型为分享则是分享id displayName String 展示名称 files Array of FileInfo objects 文件列表 expireTime String 失效时间 status Integer 0:根据失效时间判断;1:文件已被删除,2:空间已失效(空间已禁用删除或者当前用户无空间权限) operatorId String 操作员id containerId String 空间id tenantId String 租户id 表5 FileInfo 参数 参数类型 描述 id String 文件id size String 文件大小 fileType String 文件类型 downloadLinks Array of DownloadLink objects 图片类型需要,图片类型 fileType为15 recycled Boolean 是否在回收站 表6 DownloadLink 参数 参数类型 描述 usage String 用途默认:'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段 downloadLink String 附件下载地址
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 nextCursor String 分页游标,如果不存在,代表已返回最后一个 shareLinks Array of ShareByMeLink objects 分享链接列表 表4 ShareByMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 分享范围,2:仅企业内用户可访问,3:指定企业用户访问 files Array of ShareFileInfo objects 分享的文件列表 displayName String 展示名称 expireTime String 失效时间 status Integer 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 comment String 分享留言 viewCnt Integer 浏览次数 downloadCnt Integer 下载次数(后续支持) saveCnt Integer 转存次数(后续支持) containerId String 分享文件所属空间id containerName String 分享文件所属空间 表5 ShareFileInfo 参数 参数类型 描述 id String *文件id fileName String *文件名,最长160个字节 fileType String 文件类型,外部输入,最长250个字符 mimeType String *内容类型 size Integer 文件大小 parentFolder Array of strings 父目录ID列表,注意:当前只取第一个父母Id fileSuffix String 文件后缀,fullFileExtension最后一个字符串 containers Array of strings 空间标识 downloadLinks Array of downloadLinks objects 下载链接 recycled Boolean 是否在回收站标识 表6 downloadLinks 参数 参数类型 描述 usage String 用途默认:'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段 downloadLink String 下载链接
  • 响应示例 状态码: 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T01:58:35.419Z", "scope" : 0, "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "displayName" : "string", "permission" : { "preview" : true, "edit" : true, "download" : true }, "extractCode" : "string", "expireTime" : "2024-06-03T01:58:35.419Z", "status" : 0, "comment" : "string", "viewCnt" : 0, "downloadCnt" : 0, "saveCnt" : 0, "containerId" : "string", "containerName" : "string" } ] }