Java SDK

<p>&nbsp;</p> <p>1. 简介</p> <ul> <li>OBS Java SDK 适用于 JDK6 及以上版本;</li> <li>本文档主要介绍 OBS Java SDK 的接口使用及注意事项;</li> <li>并且假设您是平安云用户,且已经开通了OBS服务;</li> <li>如果您还没有开通或者还不了解平安云 OBS 服务,请登录<a href="/ssr/products/OBS" target="_blank">OBS产品主页 </a>进行了解。</li> </ul> <p>2. SDK下载</p> <p>Java SDK 开发包最新版本 <a href="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20201205094846-1ec41fdc9667.jar?response-content-disposition=attachment%3Bfilename%3Dpingan-obs-java-sdk-3.9.0.1.jar" target="_blank">v3.9.0.1</a>。</p> <p>3. API概览</p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:219px"> <p>API</p> </th> <th style="width:479px"> <p>描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:219px"> <p>getFromConfigFile</p> </td> <td style="width:479px"> <p>初始化服务</p> </td> </tr> <tr> <td style="width:219px"> <p>getFromConfigObject</p> </td> <td style="width:479px"> <p>初始化服务</p> </td> </tr> <tr> <td style="width:219px"> <p>putObject</p> </td> <td style="width:479px"> <p>以 File 对象上传对象存储,若对象存在则更新。</p> </td> </tr> <tr> <td style="width:219px"> <p>batchPutObject</p> </td> <td style="width:479px"> <p>同时上传多个 File 对象到 OBS。</p> </td> </tr> <tr> <td style="width:219px"> <p>putObjectMultipart</p> </td> <td style="width:479px"> <p>对于大文件上传,可以切分成片上传。在以下情况下,应该考虑使用分片上传:</p> <ul> <li>文件大于 100M</li> <li>网络环境差,上传易导致失败</li> <li>需要支持断点续传</li> </ul> </td> </tr> <tr> <td style="width:219px"> <p>abortMultipartUpload</p> </td> <td style="width:479px"> <p>分片上传的接口中,当参数 MutilpartUploadFileRequest 的 enableCheckpoint 被设置成 true 时(默认为true),断点续传功能被开启。断点续传允许重试失败的分片,而不需重传已经成功的分片。分片上传会在客户端的文件系统中创建一个分片记录(.ucp)文件。开启断点续传功能后,上传会读取该文件中的记录,而只传还未完成的分片;若此记录文件不存在,则会创建该记录文件,并从头开始上传文件。 由于分片上传的每个片会驻留在 OBS 中,直到所有分片上传完成且执行 complete 操作。未执行 complete 操作的上传,其相关的分片将占用存储资源。用户需要调用取消分片上传的接口来删除这些分片。</p> </td> </tr> <tr> <td style="width:219px"> <p>putAndCompressObject</p> </td> <td style="width:479px"> <p>将File对象进行压缩上传到对象存储,若对象存在则更新。</p> </td> </tr> <tr> <td style="width:219px"> <p>getObject</p> </td> <td style="width:479px"> <p>下载指定对象,此方法将占用一个Http连接,在Content读取完毕或显示关闭时释放连接。若仅为了获得对象的描述信息而非内容,请使用headObject接口。</p> </td> </tr> <tr> <td style="width:219px"> <p>getSignedUrl</p> </td> <td style="width:479px"> <p>获取对象的已签名的下载 URL。</p> </td> </tr> <tr> <td style="width:219px"> <p>getImageViewUrl</p> </td> <td style="width:479px"> <p>获取图片处理下载链接。</p> </td> </tr> <tr> <td style="width:219px"> <p>batchGetObject</p> </td> <td style="width:479px"> <p>根据多个文件的 objectKey 同时下载多个文件。</p> </td> </tr> <tr> <td style="width:219px"> <p>getAndUncompressObject</p> </td> <td style="width:479px"> <p>解压指定objectKey对象,然后进行下载。</p> </td> </tr> <tr> <td style="width:219px"> <p>listObjects</p> </td> <td style="width:479px"> <p>查询bucket下的对象列表。</p> </td> </tr> <tr> <td style="width:219px"> <p>headObject</p> </td> <td style="width:479px"> <p>获得对象描述信息以及自定义元数据。</p> </td> </tr> <tr> <td style="width:219px"> <p>deleteObject</p> </td> <td style="width:479px"> <p>删除指定对象。</p> </td> </tr> <tr> <td style="width:219px"> <p>encryptFile</p> </td> <td style="width:479px"> <p>客户端加密是指用户数据在发送给远端服务器之前,通过SDK完成加密,而加密所用的密钥由用户方自己保存,从而可以保证用户数据安全和密钥唯一性,即使数据泄漏别人也无法解密得到原始数据。</p> </td> </tr> <tr> <td style="width:219px"> <p>encryptInputStream</p> </td> <td style="width:479px"> <p>客户端加密是指用户数据在发送给远端服务器之前,通过SDK完成加密,而加密所用的密钥由用户方自己保存,从而可以保证用户数据安全和密钥唯一性,即使数据泄漏别人也无法解密得到原始数据。</p> </td> </tr> <tr> <td style="width:219px"> <p>decryptFile</p> </td> <td style="width:479px"> <p>客户端解密是指用户从OBS服务器获取密文后,在客户端进行数据解密。</p> </td> </tr> <tr> <td style="width:219px"> <p>decryptInputStream</p> </td> <td style="width:479px"> <p>客户端解密是指用户从OBS服务器获取密文后,在客户端进行数据解密。</p> </td> </tr> <tr> <td style="width:219px"> <p>getImageView</p> </td> <td style="width:479px"> <p>格式转换,获取适配图片,支持格式 jpeg,tiff, gif, bmp, png ,其中 gif 格式只会保留第一帧图片,此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。参数 width 和 height 至少需传入一个,不能同时为 0。</p> </td> </tr> <tr> <td style="width:219px"> <p>getThumbnail</p> </td> <td style="width:479px"> <p>根据自定义规则获取缩略图或视频截图,缩略图支持格式jpeg, tiff, gif, bmp, png,截图支持格式: jpg和png,此法将占用一个Http连接,在Content读取完毕或显示关闭时释放连接。</p> </td> </tr> <tr> <td style="width:219px"> <p>getCutImage</p> </td> <td style="width:479px"> <p>根据宽度和高度获取剪切图,先截取图片左边和上边,截取到一定大小后(比较小的时候),会截取四边,保留中间部分,当设定值大于图片实际宽、高时,会根据实际大小裁剪,支持 jpeg, tiff, gif, bmp, emf, exif, wmf, icon, png, memoryBmp, webp。此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> </td> </tr> <tr> <td style="width:219px"> <p>getImageInfo</p> </td> <td style="width:479px"> <p>获取指定图片信息</p> </td> </tr> <tr> <td style="width:219px"> <p>transCodingMedia</p> </td> <td style="width:479px"> <p>媒体转码,此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> </td> </tr> <tr> <td style="width:219px"> <p>getVedioFrame</p> </td> <td style="width:479px"> <p>获取视频截图,此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> </td> </tr> <tr> <td style="width:219px"> <p>getMediaInfo</p> </td> <td style="width:479px"> <p>获取媒体对象的信息。</p> </td> </tr> <tr> <td style="width:219px"> <p>queryMediaByCKs</p> </td> <td style="width:479px"> <p>获取 media 转码记录,用于查询转码进度。</p> </td> </tr> <tr> <td style="width:219px"> <p>deleteMediaByCK</p> </td> <td style="width:479px"> <p>根据转换后新生成的 key 删除 media 转码记录及转码后的 object。</p> </td> </tr> <tr> <td style="width:219px"> <p>pfop</p> </td> <td style="width:479px"> <p>图片、音视频异步处理并持久化。</p> </td> </tr> <tr> <td style="width:219px"> <p>prefop</p> </td> <td style="width:479px"> <p>操作pfop操作进度和操作结果。</p> </td> </tr> </tbody> </table> <p>4. API描述</p> <p><strong>(1)初始化服务</strong></p> <p><strong>描述</strong></p> <p>RadosgwService 是 OBS 服务的 JAVA 客户端,它为调用者提供一系列与 OBS 进行交互的接口,用于上传下载文件,加密解密文件,处理图片,音视频文件等。用户在调用 SDK 接口前<strong>必须</strong>先初始化 RadosgwService 服务。</p> <p>基本<strong>配置文件</strong>创建服务实例:</p> <ul> <li> <p>基于 <strong>ObsClientConfig 接口对象</strong>创建服务实例:</p> <pre> String configFileName = ; RadosgwService service = RadosgwServiceFactory. getFromConfigFile(configFileName);</pre> <p>将配置文件信息放在 classpath 下,作为 configFileName.properties 文件存放。</p> <pre> access_id = theAccessId security_id = theSecurityId rgw_addr = theObsEndPoint</pre> </li> <li>基于 <strong>ObsClientConfig 接口对象</strong>创建服务实例: <pre> ObsClientConfig oc = <strong>new</strong> ObsClientConfig() { <strong>public</strong> String getUserAgent() { &nbsp;&nbsp;&nbsp; <strong>return</strong> <span style="color:#2a00ff">&quot;&quot;</span>; &nbsp; } &nbsp; <strong>public</strong> String getObsUrl() { &nbsp;&nbsp;&nbsp; <strong>return</strong> <span style="color:#2a00ff">&quot;&quot;</span>; &nbsp; } &nbsp; <strong>public</strong> String getObsAccessKey() { &nbsp;&nbsp;&nbsp; <strong>return</strong> <span style="color:#2a00ff">&quot;&quot;</span>; &nbsp; } &nbsp; <strong>public</strong> String getObsSecret() { &nbsp;&nbsp;&nbsp; <strong>return</strong> <span style="color:#2a00ff">&quot;&quot;</span>; &nbsp; } }; RadosgwService service = RadosgwServiceFactory.getFromConfigObject(oc);</pre> 说明: <p>theObsEndPoint请从OBS控制台去获取endpoint,建议使用https 的请求,如&quot;https://obs-cn-shenzhen.yun.pingan.com&quot;。</p> </li> </ul> <p><strong>(2) putObject(文件上传)</strong></p> <p><strong>接口描述</strong></p> <p>以 File 对象上传对象存储,若对象存在则更新。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:95px"> <p>参数名称</p> </th> <th style="width:63px"> <p>参数类型</p> </th> <th style="width:64px"> <p>是否必须</p> </th> <th style="width:106px"> <p>参数描述</p> </th> <th style="width:348px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:95px"> <p>bucket</p> </td> <td style="width:63px"> <p>String</p> </td> <td style="width:64px"> <p>true</p> </td> <td style="width:106px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:348px"> <p>-</p> </td> </tr> <tr> <td style="width:95px"> <p>objectKey</p> </td> <td style="width:63px"> <p>String</p> </td> <td style="width:64px"> <p>true</p> </td> <td style="width:106px"> <p>对象 Key</p> </td> <td style="width:348px"> <p>需自行实现策略保证同一 bucket 下 objectKey唯一, 首字符不能为路径符。</p> </td> </tr> <tr> <td style="width:95px"> <p>localFile</p> </td> <td style="width:63px"> <p>File</p> </td> <td style="width:64px"> <p>true</p> </td> <td style="width:106px"> <p>待上传的文件对象</p> </td> <td style="width:348px"> <p>不能超过 1GB</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:693px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:140px"> <p>参数名称</p> </th> <th style="width:165px"> <p>参数类型</p> </th> <th style="width:196px"> <p>参数描述</p> </th> <th style="width:164px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:140px"> <p>putObjectResult</p> </td> <td style="width:165px"> <p>PutObjectResult</p> </td> <td style="width:196px"> <p>PutObjectResult 对象</p> </td> <td style="width:164px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(3) putObject(文件上传)</strong></p> <p><strong>接口描述</strong></p> <p>以 File 对象上传对象存储并附带自定义元数据,若对象存在则更新。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:94px"> <p>参数名称</p> </th> <th style="width:109px"> <p>参数类型</p> </th> <th style="width:77px"> <p>是否必须</p> </th> <th style="width:106px"> <p>参数描述</p> </th> <th style="width:311px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:94px"> <p>bucket</p> </td> <td style="width:109px"> <p>String</p> </td> <td style="width:77px"> <p>true</p> </td> <td style="width:106px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:311px"> <p>-</p> </td> </tr> <tr> <td style="width:94px"> <p>objectKey</p> </td> <td style="width:109px"> <p>String</p> </td> <td style="width:77px"> <p>true</p> </td> <td style="width:106px"> <p>对象 Key</p> </td> <td style="width:311px"> <p>需自行实现策略保证同一 bucket 下 objectKey唯一, 首字符不能为路径符。</p> </td> </tr> <tr> <td style="width:94px"> <p>localFile</p> </td> <td style="width:109px"> <p>File</p> </td> <td style="width:77px"> <p>true</p> </td> <td style="width:106px"> <p>待上传的文件对象</p> </td> <td style="width:311px"> <p>不能超过 1GB</p> </td> </tr> <tr> <td style="width:94px"> <p>metadata</p> </td> <td style="width:109px"> <p>ObjectMetadata</p> </td> <td style="width:77px"> <p>true</p> </td> <td style="width:106px"> <p>自定义元数据</p> </td> <td style="width:311px"> <p>key-value 格式,key 只允许使用大写字母、数字、中横线</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:711px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:144px"> <p>参数名称</p> </th> <th style="width:169px"> <p>参数类型</p> </th> <th style="width:213px"> <p>参数描述</p> </th> <th style="width:156px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:144px"> <p>putObjectResult</p> </td> <td style="width:169px"> <p>PutObjectResult</p> </td> <td style="width:213px"> <p>PutObjectResult 对象</p> </td> <td style="width:156px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(4) putObject(流式上传)</strong></p> <p><strong>接口描述</strong></p> <p>以 InputStream 形式上传对象存储,若对象存在则更新,建议仅用于上传较小的对象<strong>。</strong></p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:105px"> <p>参数名称</p> </th> <th style="width:94px"> <p>参数类型</p> </th> <th style="width:88px"> <p>是否必须</p> </th> <th style="width:152px"> <p>参数描述</p> </th> <th style="width:243px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:105px"> <p>bucket</p> </td> <td style="width:94px"> <p>String</p> </td> <td style="width:88px"> <p>true</p> </td> <td style="width:152px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:243px"> <p>-</p> </td> </tr> <tr> <td style="width:105px"> <p>objectKey</p> </td> <td style="width:94px"> <p>String</p> </td> <td style="width:88px"> <p>true</p> </td> <td style="width:152px"> <p>对象 Key</p> </td> <td style="width:243px"> <p>需自行实现策略保证同一 bucket 下 objectKey唯一, 首字符不能为路径符。</p> </td> </tr> <tr> <td style="width:105px"> <p>inputStream</p> </td> <td style="width:94px"> <p>InputStream</p> </td> <td style="width:88px"> <p>true</p> </td> <td style="width:152px"> <p>待上传的流</p> </td> <td style="width:243px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:715px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:141px"> <p>参数名称</p> </th> <th style="width:148px"> <p>参数类型</p> </th> <th style="width:190px"> <p>参数描述</p> </th> <th style="width:208px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:141px"> <p>putObjectResult</p> </td> <td style="width:148px"> <p>PutObjectResult</p> </td> <td style="width:190px"> <p>PutObjectResult 对象</p> </td> <td style="width:208px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(5) putObject(流式上传)</strong></p> <p><strong>接口描述</strong></p> <p>以 InputStream 形式上传对象存储并附带对象元数据,若对象存在则更新,大、小对象上传均适用<strong>。</strong></p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:110px"> <p>参数名称</p> </th> <th style="width:104px"> <p>参数类型</p> </th> <th style="width:98px"> <p>是否必须</p> </th> <th style="width:124px"> <p>参数描述</p> </th> <th style="width:244px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:110px"> <p>bucket</p> </td> <td style="width:104px"> <p>String</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:124px"> <p style="text-align:center">保存对象的 bucket 名称</p> </td> <td style="width:244px"> <p>-</p> </td> </tr> <tr> <td style="width:110px"> <p>objectKey</p> </td> <td style="width:104px"> <p>String</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:124px"> <p style="text-align:center">对象 Key</p> </td> <td style="width:244px"> <p>需自行实现策略保证同一 bucket 下 objectKey唯一, 首字符不能为路径符。</p> </td> </tr> <tr> <td style="width:110px"> <p>inputStream</p> </td> <td style="width:104px"> <p>InputStream</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:124px"> <p style="text-align:center">待上传的流</p> </td> <td style="width:244px"> <p>-</p> </td> </tr> <tr> <td style="width:110px"> <p>metadata</p> </td> <td style="width:104px"> <p>ObjectMetadata</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:124px"> <p style="text-align:center">自定义元数据</p> </td> <td style="width:244px"> <p>key-value 格式,key 只允许使用小写字母、数字、中横线。建议指定 ContentLength,若不指定,流会被首先全部读取到内存再做上传;建议指定 contentType,若不指定,会赋予默认类型 application/octet-stream。</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:708px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:160px"> <p>参数名称</p> </th> <th style="width:136px"> <p>参数类型</p> </th> <th style="width:183px"> <p>参数描述</p> </th> <th style="width:201px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:160px"> <p>putObjectResult</p> </td> <td style="width:136px"> <p>PutObjectResult</p> </td> <td style="width:183px"> <p>PutObjectResult 对象</p> </td> <td style="width:201px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(6) batchPutObject(批量上传)</strong></p> <p><strong>接口描述</strong></p> <p>同时上传多个 File 对象到 OBS。</p> <p><strong>请求参数</strong></p> <table style="width:710px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:105px"> <p>参数名称</p> </th> <th style="width:107px"> <p>参数类型</p> </th> <th style="width:120px"> <p>是否必须</p> </th> <th style="width:154px"> <p>参数描述</p> </th> <th style="width:190px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:105px"> <p>bucket</p> </td> <td style="width:107px"> <p>String</p> </td> <td style="width:120px"> <p>true</p> </td> <td style="width:154px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:190px"> <p>-</p> </td> </tr> <tr> <td style="width:105px"> <p>batchPutFiles</p> </td> <td style="width:107px"> <p>BatchPutFile[]</p> </td> <td style="width:120px"> <p>true</p> </td> <td style="width:154px"> <p>批量上传的文件对象数组</p> </td> <td style="width:190px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:188px"> <p>参数名称</p> </th> <th style="width:153px"> <p>参数类型</p> </th> <th style="width:327px"> <p>参数描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:188px"> <p>BatchPutObjectResults</p> </td> <td style="width:153px"> <p>List</p> </td> <td style="width:327px"> <p>每个 BatchPutObjectResult 对象中包含该文件上传信息(比如上传是否成功,上传失败原因,文件 MD5 值等)。</p> </td> <td> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(7) putObjectMultipart(分片上传)</strong></p> <p><strong>接口描述</strong></p> <p>对于大文件上传,可以切分成片上传。在以下情况下,应该考虑使用分片上传:</p> <ul> <li>文件大于 100M</li> <li>网络环境差,上传易导致失败</li> <li>需要支持断点续传</li> </ul> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p>参数名称</p> </th> <th style="width:136px"> <p>参数类型</p> </th> <th style="width:118px"> <p>是否必须</p> </th> <th style="width:280px"> <p>参数描述</p> </th> </tr> </thead> <tbody> <tr> <td> <p>uploadFileRequest</p> </td> <td style="width:136px"> <p>MutilpartUploadFileRequest</p> </td> <td style="width:118px"> <p>true</p> </td> <td style="width:280px"> <p>分片上传参数 uploadFileRequest 说明:</p> <ul> <li>每个分片(除了最后一个分片)的大小必须不小于 5M,最后一个分片的大小无限制;</li> <li>若任何一个分片(非最后一个分片)小于 5M,每个分片的上传不会失败,然而分片完成操作(complete)会失败。</li> <li>enableCheckpoint 用于设置是否启用断点续传。默认启用。通过调用 uploadFileRequest.setEnableCheckpoint(false) 关闭断点续传功能。</li> <li>checkpointFile 用于设置断点续传 ucp 文件的保存位置。默认与待上传文件位于同一个目录下面。若非特殊需求,不需要更改此设置。</li> <li>uploadNotifier 用于设置分片上传的通知接收者。可以实现一个 MutilpartUploadNotifier,并调用 uploadFileRequest.setUploadNotifier 来接收分片上传的进展的通知,以达到如进度感知等目的。</li> <li>一般情况下,应当开启 enabledMd5 来保证文件内容的完整性(默认开启)。</li> </ul> <p>分片上传相较于 s3 已经简化了使用步骤。仅需要调用一个接口。</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong>(8) abortMultipartUpload(取消分片上传)</strong></p> <p><strong>接口描述</strong></p> <p>取消分片上传。分片上传的接口中,当参数 MutilpartUploadFileRequest 的 enableCheckpoint 被设置成 true 时(默认为true),断点续传功能被开启。断点续传允许重试失败的分片,而不需重传已经成功的分片。分片上传会在客户端的文件系统中创建一个分片记录(.ucp)文件。开启断点续传功能后,上传会读取该文件中的记录,而只传还未完成的分片;若此记录文件不存在,则会创建该记录文件,并从头开始上传文件。 由于分片上传的每个片会驻留在 OBS 中,直到所有分片上传完成且执行 complete 操作。未执行 complete 操作的上传,其相关的分片将占用存储资源。用户需要调用取消分片上传的接口来删除这些分片。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:124px"> <p>参数名称</p> </th> <th style="width:209px"> <p>参数类型</p> </th> <th style="width:94px"> <p>是否必须</p> </th> <th style="width:272px"> <p>参数描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:124px"> <p>abortRequest</p> </td> <td style="width:209px"> <p>AbortMutilpartUploadRequest</p> </td> <td style="width:94px"> <p>true</p> </td> <td style="width:272px"> <p>初始化</p> <p>abortRequest参数需传入:</p> <p>bucket: 对象的 bucket 名称</p> <p>objectKey:对象 Key</p> <p>uploadId: 待删除的分片所属的 upload 编号。必须实现 uploadNotifier,在对应通知中获取 uploadId</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong>(9) putAndCompressObject(文件压缩上传)</strong></p> <p><strong>接口描述</strong></p> <p>将File对象进行压缩上传到对象存储,若对象存在则更新。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:108px"> <p>参数名称</p> </th> <th style="width:86px"> <p>参数类型</p> </th> <th style="width:82px"> <p>是否必须</p> </th> <th style="width:173px"> <p>参数描述</p> </th> <th style="width:225px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:108px"> <p>bucket</p> </td> <td style="width:86px"> <p>String</p> </td> <td style="width:82px"> <p>true</p> </td> <td style="width:173px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:225px"> <p>-</p> </td> </tr> <tr> <td style="width:108px"> <p>objectKey</p> </td> <td style="width:86px"> <p>String</p> </td> <td style="width:82px"> <p>true</p> </td> <td style="width:173px"> <p>对象 Key</p> </td> <td style="width:225px"> <p>需自行实现策略保证同一 bucket 下 objectKey 唯一, 不能为空,首字符不能为路径符</p> </td> </tr> <tr> <td style="width:108px"> <p>localFile</p> </td> <td style="width:86px"> <p>File</p> </td> <td style="width:82px"> <p>true</p> </td> <td style="width:173px"> <p>待上传的文件对象</p> </td> <td style="width:225px"> <p>不能超过 1GB</p> </td> </tr> <tr> <td style="width:108px"> <p>metadata</p> </td> <td style="width:86px"> <p>ObjectMetadata</p> </td> <td style="width:82px"> <p>true</p> </td> <td style="width:173px"> <p>自定义元数据</p> </td> <td style="width:225px"> <p>key-value 格式,key 只允许使用小写字母、数字、中横线</p> </td> </tr> <tr> <td style="width:108px"> <p>mode</p> </td> <td style="width:86px"> <p>CompressMode</p> </td> <td style="width:82px"> <p>true</p> </td> <td style="width:173px"> <p>压缩模式,目前支持<strong>MS,ML,ZIP,GZP,LZ4,LZO</strong>模式</p> </td> <td style="width:225px"> <p><strong>极限模式(ML)</strong>:使用FastLZ算法对文件进行压缩/解压。FastLZ算法针对文本文件有很好压缩效果,经测试压缩率接近10%(压缩后文件大小/压缩前文件大小),同时对图片类型格式可取得较好的压缩效果,尤其对位图压缩率可以小于60%。但对于已经压缩文件和音视频文件压缩效果十分差。其压缩速度和解压速度优于传统zip方式。</p> <p><strong>极速模式(MS)</strong>:使用SNAPPY压缩算法对文件进行压缩/解压。SNAPPY算法针对文本文件压缩/解压,压缩率15%左右,图片类中对位图压缩缩率小于60%,但其压缩/解压速度为极限压缩数度5倍以上(压缩速度最可达100M/S,解压速度可达:400M/s)。</p> <p><strong>zip模式(ZIP)</strong>:使用JDK自带GZIP压缩算法对文件进行压缩/解压 。其详细信息参照JDK。</p> <p><strong>GZIP压缩(GZIP)</strong>:使用JDK自带DEFLATE算法对文件进行压缩/解压 。其详细信息参照JDK。</p> <p><strong>LZ4模式(LZ4)</strong>:使用LZ77优化后的算法LZ4对文件进行压缩/解压。其主要特点牺牲压缩率获取压缩速度。处理文本文件压缩率大于30%,图片类文件完全无法压缩。 压缩速度和解压速度略小于极速模式。</p> <p><strong>LZO模式(LZO)</strong>:LZO 是一个用 ANSI C语言编写的无损压缩库。LZO 非常适合进行数据的实时压缩解压处理,这就是说他更关心操作速度,而不是压缩比例。压缩速度为极速模式二分之一,解压速度为极速模式四分之一。</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:699px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:133px"> <p>参数名称</p> </th> <th style="width:165px"> <p>参数类型</p> </th> <th style="width:257px"> <p>参数描述</p> </th> <th style="width:116px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:133px"> <p>putObjectResult</p> </td> <td style="width:165px"> <p>PutObjectResult</p> </td> <td style="width:257px"> <p>PutObjectResult对象</p> </td> <td style="width:116px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(10)getObject(文件下载)</strong></p> <p><strong>接口描述</strong></p> <p>下载指定对象,此方法将占用一个Http连接,在Content读取完毕或显示关闭时释放连接。若仅为了获得对象的描述信息而非内容,请使用headObject接口。</p> <p><strong>请求参数</strong></p> <table style="width:696px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:106px"> <p>参数名称</p> </th> <th style="width:78px"> <p>参数类型</p> </th> <th style="width:145px"> <p>是否必须</p> </th> <th style="width:217px"> <p>参数描述</p> </th> <th style="width:113px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:106px"> <p>bucket</p> </td> <td style="width:78px"> <p>String</p> </td> <td style="width:145px"> <p>true</p> </td> <td style="width:217px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:113px"> <p>-</p> </td> </tr> <tr> <td style="width:106px"> <p>objectKey</p> </td> <td style="width:78px"> <p>String</p> </td> <td style="width:145px"> <p>true</p> </td> <td style="width:217px"> <p>对象 Key</p> </td> <td style="width:113px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:689px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:97px"> <p>参数名称</p> </th> <th style="width:128px"> <p>参数类型</p> </th> <th style="width:319px"> <p>参数描述</p> </th> <th style="width:116px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:97px"> <p>s3object</p> </td> <td style="width:128px"> <p>S3Object</p> </td> <td style="width:319px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:116px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(11)getSignedUrl(获取下载链接)</strong></p> <p><strong>接口描述</strong></p> <p>获取对象的已签名的下载 URL,使用默认设置。默认有效时间为 20 秒<strong>。</strong></p> <p><strong>请求参数</strong></p> <table style="width:623px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:87px"> <p>参数名称</p> </th> <th style="width:74px"> <p>参数类型</p> </th> <th style="width:92px"> <p>是否必须</p> </th> <th style="width:146px"> <p>参数描述</p> </th> <th style="width:188px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:87px"> <p>bucket</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:92px"> <p>true</p> </td> <td style="width:146px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:188px"> <p>-</p> </td> </tr> <tr> <td style="width:87px"> <p>objectKey</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:92px"> <p>true</p> </td> <td style="width:146px"> <p>对象 Key</p> </td> <td style="width:188px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:661px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:88px"> <p>参数名称</p> </th> <th style="width:96px"> <p>参数类型</p> </th> <th style="width:153px"> <p>参数描述</p> </th> <th style="width:296px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:88px"> <p>url</p> </td> <td style="width:96px"> <p>String</p> </td> <td style="width:153px"> <p>已签名的对象下载 url</p> </td> <td style="width:296px"> <p>url 具有默认的有效期,下载文件名为对象 Key</p> </td> </tr> </tbody> </table> <p><strong>(12)getSignedUrl(获取下载链接)</strong></p> <p><strong>接口描述</strong></p> <p>获取对象的已签名的下载 URL,指定返回 contentDisposition 头以告知浏览器如何显示文件,并使用默认的 url 有效期 20 秒<strong>。</strong></p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p>参数名称</p> </th> <th style="width:98px"> <p>参数类型</p> </th> <th style="width:136px"> <p>是否必须</p> </th> <th style="width:263px"> <p>参数描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>bucket</p> </td> <td style="width:98px"> <p>String</p> </td> <td style="width:136px"> <p>true</p> </td> <td style="width:263px"> <p>保存对象的 bucket 名称</p> </td> <td> <p>-</p> </td> </tr> <tr> <td> <p>objectKey</p> </td> <td style="width:98px"> <p>String</p> </td> <td style="width:136px"> <p>true</p> </td> <td style="width:263px"> <p>对象 Key</p> </td> <td> <p>-</p> </td> </tr> <tr> <td> <p>contentDisposition</p> </td> <td style="width:98px"> <p>String</p> </td> <td style="width:136px"> <p>true</p> </td> <td style="width:263px"> <p>在请求url时,期望云存储服务端返回的 content-disposition 头信息</p> </td> <td> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:681px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:80px"> <p>参数名称</p> </th> <th style="width:95px"> <p>参数类型</p> </th> <th style="width:144px"> <p>参数描述</p> </th> <th style="width:334px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:80px"> <p>url</p> </td> <td style="width:95px"> <p>String</p> </td> <td style="width:144px"> <p>已签名的对象下载 url</p> </td> <td style="width:334px"> <p>已签名的对象下载 url,url 具有默认的有效期。最长 15 mins</p> </td> </tr> </tbody> </table> <p><strong>(13)getSignedUrl(获取下载链接)</strong></p> <p><strong>接口描述</strong></p> <p>获取对象的已签名的下载URL,指定返回contentDisposition头以告知浏览器如何显示文件,并指定url有效期(秒)<strong>。</strong></p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:134px"> <p>参数名称</p> </th> <th style="width:74px"> <p>参数类型</p> </th> <th style="width:70px"> <p>是否必须</p> </th> <th style="width:260px"> <p>参数描述</p> </th> <th style="width:144px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:134px"> <p>bucket</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:70px"> <p>true</p> </td> <td style="width:260px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:144px"> <p>-</p> </td> </tr> <tr> <td style="width:134px"> <p>objectKey</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:70px"> <p>true</p> </td> <td style="width:260px"> <p>对象 Key</p> </td> <td style="width:144px"> <p>-</p> </td> </tr> <tr> <td style="width:134px"> <p>contentDisposition</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:70px"> <p>true</p> </td> <td style="width:260px"> <p>在请求url时,期望云存储服务端返回的 content-disposition 头信息</p> </td> <td style="width:144px"> <p>-</p> </td> </tr> <tr> <td style="width:134px"> <p>expireSeconds</p> </td> <td style="width:74px"> <p>long</p> </td> <td style="width:70px"> <p>true</p> </td> <td style="width:260px"> <p>url 有效秒数</p> </td> <td style="width:144px"> <p>url 生成后,在此时间段内有效,过期的 url 会被云存储拒绝访问</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:712px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:89px"> <p>参数名称</p> </th> <th style="width:120px"> <p>参数类型</p> </th> <th style="width:315px"> <p>参数描述</p> </th> <th style="width:160px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:89px"> <p>url</p> </td> <td style="width:120px"> <p>String</p> </td> <td style="width:315px"> <p>已签名的对象下载 url</p> </td> <td style="width:160px">&nbsp;</td> </tr> </tbody> </table> <p><strong>(14)getImageViewUrl(获取图片处理下载链接)</strong></p> <p><strong>接口描述</strong></p> <p>获取图片处理下载链接<strong>。</strong></p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th> <p>字段名称</p> </th> <th style="width:85px"> <p>字段类型</p> </th> <th style="width:114px"> <p>是否必须</p> </th> <th style="width:342px"> <p>字段描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>bucketName</p> </td> <td style="width:85px"> <p>String</p> </td> <td style="width:114px"> <p>true</p> </td> <td style="width:342px"> <p>保存对象的 bucket 名称</p> </td> <td> <p>-</p> </td> </tr> <tr> <td> <p>objectKey</p> </td> <td style="width:85px"> <p>String</p> </td> <td style="width:114px"> <p>true</p> </td> <td style="width:342px"> <p>对象 Key</p> </td> <td> <p>-</p> </td> </tr> <tr> <td> <p>contentDisposition</p> </td> <td style="width:85px"> <p>String</p> </td> <td style="width:114px"> <p>true</p> </td> <td style="width:342px"> <p>在请求url时,期望云存储服务端返回的 content-disposition 头信息,默认为null</p> </td> <td> <p>-</p> </td> </tr> <tr> <td> <p>expireSeconds</p> </td> <td style="width:85px"> <p>long</p> </td> <td style="width:114px"> <p>true</p> </td> <td style="width:342px"> <p>url有效秒数,url生成后,在此时间段内有效,过期的url会被云存储拒绝访问,默认为20s</p> </td> <td> <p>-</p> </td> </tr> <tr> <td> <p>formatOps</p> </td> <td style="width:85px"> <p>String</p> </td> <td style="width:114px"> <p>true</p> </td> <td style="width:342px"> <p>参数是必须的,但需要设置为空NULL。</p> </td> <td> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:698px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:92px"> <p>字段名称</p> </th> <th style="width:108px"> <p>字段类型</p> </th> <th style="width:292px"> <p>字段描述</p> </th> <th style="width:178px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:92px"> <p>url</p> </td> <td style="width:108px"> <p>String</p> </td> <td style="width:292px"> <p>已签名的图片处理下载链接</p> </td> <td style="width:178px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(15)batchGetObject(批量下载)</strong></p> <p><strong>接口描述</strong></p> <p>根据多个文件的 objectKey 同时下载多个文件。</p> <p><strong>请求参数</strong></p> <table style="width:667px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:97px"> <p>字段名称</p> </th> <th style="width:99px"> <p>字段类型</p> </th> <th style="width:98px"> <p>是否必须</p> </th> <th style="width:195px"> <p>字段描述</p> </th> <th style="width:144px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:97px"> <p>bucketName</p> </td> <td style="width:99px"> <p>String</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:195px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:144px"> <p>-</p> </td> </tr> <tr> <td style="width:97px"> <p>objectKeys</p> </td> <td style="width:99px"> <p>String[]</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:195px"> <p>objectKey 数组</p> </td> <td style="width:144px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:138px"> <p>字段名称</p> </th> <th style="width:150px"> <p>字段类型</p> </th> <th style="width:384px"> <p>字段描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:138px"> <p>batchS3ObjectList</p> </td> <td style="width:150px"> <p>List</p> </td> <td style="width:384px"> <p>批量下载完毕后,SDK 将返回结果对象 List,循环该 List 去得到每个文件下载后的对象,该对象中包含所下载文件的文件流,另外还有该文件下载时的信息(比如下载是否成功,下载失败原因,文件 MD5 值等。)</p> </td> <td> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(16)getAndUncompressObject(文件解压下载)</strong></p> <p><strong>接口描述</strong></p> <p>解压指定objectKey对象,然后进行下载。</p> <p><strong>请求参数</strong></p> <table style="width:635px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:71px"> <p>参数名称</p> </th> <th style="width:86px"> <p>参数类型</p> </th> <th style="width:107px"> <p>是否必须</p> </th> <th style="width:162px"> <p>参数描述</p> </th> <th style="width:175px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:71px"> <p>bucket</p> </td> <td style="width:86px"> <p>String</p> </td> <td style="width:107px"> <p>true</p> </td> <td style="width:162px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:175px"> <p>-</p> </td> </tr> <tr> <td style="width:71px"> <p>objectKey</p> </td> <td style="width:86px"> <p>String</p> </td> <td style="width:107px"> <p>true</p> </td> <td style="width:162px"> <p>对象 Key</p> </td> <td style="width:175px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:619px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:99px"> <p>字段名称</p> </th> <th style="width:94px"> <p>字段类型</p> </th> <th style="width:305px"> <p>字段描述</p> </th> <th style="width:93px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:99px"> <p>s3Object</p> </td> <td style="width:94px"> <p>S3Object</p> </td> <td style="width:305px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:93px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(17)listObjects(查询bucket下的对象列表)</strong></p> <p><strong>接口描述</strong></p> <p>查询bucket下的对象列表。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:135px"> <p>参数名称</p> </th> <th style="width:126px"> <p>参数类型</p> </th> <th style="width:72px"> <p>是否必须</p> </th> <th style="width:338px"> <p>参数描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:135px"> <p>listObjectsRequest</p> </td> <td style="width:126px"> <p>ListObjectsRequest</p> </td> <td style="width:72px"> <p style="text-align:center">true</p> </td> <td style="width:338px"> <p>listObjectsRequest: 查询参数:</p> <p>listObjectsRequest.delimiter 一个用于对KEY进行分组的字符。如果查询参数中指定了prefix,则在查询结果中,对KEY计算从prefix到第一次匹配delimiter的位置的截取串,所有KEY按此截取串进行分组且将结果放于元素CommonPrefixes下;若未指定prefix,则截取从KEY的开始位置执行计算。CommonPrefixes下面的KEY将不会在出现在查询结果中的其它位置。</p> <p>listObjectsRequest.marker指定查询KEY的起始位置(不包括此KEY)。</p> <p>listObjectsRequest. max-keys 查询结果最大Key的数量,默认为1000。</p> <p>listObjectsRequest.prefix指定查询前缀。</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:111px"> <p>字段名称</p> </th> <th style="width:117px"> <p>字段类型</p> </th> <th style="width:465px"> <p>字段描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:111px"> <p>objectListing</p> </td> <td style="width:117px"> <p>ObjectListing</p> </td> <td style="width:465px"> <p>查询结果:</p> <p>ObjectListing .isTruncated 查询结果是否被截取。若被截取,则表示查询还有下一页。</p> <p>ObjectListing. nextMarker 下一页的mark。<strong>注意:</strong>此字段仅在请求中包含了delimiter参数时才会出现在响应中。否则,应该取响应中的KEY列表(object Summarie</p> <p>s)的最后一个元素作为下一页请求的mark参数。</p> </td> </tr> </tbody> </table> <p><strong>(18)headObject(获取文件信息)</strong></p> <p><strong>接口描述</strong></p> <p>获得对象描述信息以及自定义元数据</p> <p><strong>请求参数</strong></p> <table style="width:704px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:86px"> <p>参数名称</p> </th> <th style="width:68px"> <p>参数类型</p> </th> <th style="width:111px"> <p>是否必须</p> </th> <th style="width:283px"> <p>参数描述</p> </th> <th style="width:122px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:86px"> <p>bucket</p> </td> <td style="width:68px"> <p>String</p> </td> <td style="width:111px"> <p>true</p> </td> <td style="width:283px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:122px"> <p>-</p> </td> </tr> <tr> <td style="width:86px"> <p>objectKey</p> </td> <td style="width:68px"> <p>String</p> </td> <td style="width:111px"> <p>true</p> </td> <td style="width:283px"> <p>对象 Key</p> </td> <td style="width:122px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:700px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:123px"> <p>字段名称</p> </th> <th style="width:124px"> <p>字段类型</p> </th> <th style="width:311px"> <p>字段描述</p> </th> <th style="width:114px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:123px"> <p>objectMetadata</p> </td> <td style="width:124px"> <p>ObjectMetadata</p> </td> <td style="width:311px"> <p style="text-align:center">对象元数据 ObjectMetadata</p> </td> <td style="width:114px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(19)deleteObject(删除Object)</strong></p> <p><strong>接口描述</strong></p> <p>删除指定对象</p> <p><strong>请求参数</strong></p> <table style="width:693px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:73px"> <p>参数名称</p> </th> <th style="width:75px"> <p>参数类型</p> </th> <th style="width:100px"> <p>是否必须</p> </th> <th style="width:254px"> <p>参数描述</p> </th> <th style="width:156px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:73px"> <p>bucket</p> </td> <td style="width:75px"> <p>String</p> </td> <td style="width:100px"> <p>true</p> </td> <td style="width:254px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:156px"> <p>-</p> </td> </tr> <tr> <td style="width:73px"> <p>objectKey</p> </td> <td style="width:75px"> <p>String</p> </td> <td style="width:100px"> <p>true</p> </td> <td style="width:254px"> <p>对象 Key</p> </td> <td style="width:156px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong>(20)encryptFile(加密文件)</strong></p> <p><strong>接口描述</strong></p> <p>客户端加密是指用户数据在发送给远端服务器之前,通过SDK完成加密,而加密所用的密钥由用户方自己保存,从而可以保证用户数据安全和密钥唯一性,即使数据泄漏别人也无法解密得到原始数据。</p> <p><strong>请求参数</strong></p> <table style="width:659px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:100px"> <p>参数名称</p> </th> <th style="width:94px"> <p>参数类型</p> </th> <th style="width:108px"> <p>是否必须</p> </th> <th style="width:219px"> <p>参数描述</p> </th> <th style="width:103px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:100px"> <p>file</p> </td> <td style="width:94px"> <p>File</p> </td> <td style="width:108px"> <p>true</p> </td> <td style="width:219px"> <p>文件对象</p> </td> <td style="width:103px"> <p>-</p> </td> </tr> <tr> <td style="width:100px"> <p>keySource</p> </td> <td style="width:94px"> <p>String</p> </td> <td style="width:108px"> <p>true</p> </td> <td style="width:219px"> <p>加密文件用的密钥</p> </td> <td style="width:103px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:652px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:131px"> <p>字段名称</p> </th> <th style="width:137px"> <p>字段类型</p> </th> <th style="width:244px"> <p>字段描述</p> </th> <th style="width:112px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:131px"> <p>inputStream</p> </td> <td style="width:137px"> <p>InputStream</p> </td> <td style="width:244px"> <p>文件加密流</p> </td> <td style="width:112px">&nbsp;</td> </tr> </tbody> </table> <p><strong>(21)encryptInputStream(加密文件流)</strong></p> <p><strong>接口描述</strong></p> <p>客户端加密是指用户数据在发送给远端服务器之前,通过SDK完成加密,而加密所用的密钥由用户方自己保存,从而可以保证用户数据安全和密钥唯一性,即使数据泄漏别人也无法解密得到原始数据。</p> <p><strong>请求参数</strong></p> <table style="width:651px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:102px"> <p>参数名称</p> </th> <th style="width:94px"> <p>参数类型</p> </th> <th style="width:94px"> <p>是否必须</p> </th> <th style="width:206px"> <p>参数描述</p> </th> <th style="width:121px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:102px"> <p>inputStream</p> </td> <td style="width:94px"> <p>InputStream</p> </td> <td style="width:94px"> <p>true</p> </td> <td style="width:206px"> <p>文件流</p> </td> <td style="width:121px"> <p>-</p> </td> </tr> <tr> <td style="width:102px"> <p>keySource</p> </td> <td style="width:94px"> <p>String</p> </td> <td style="width:94px"> <p>true</p> </td> <td style="width:206px"> <p>加密文件用的密钥</p> </td> <td style="width:121px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:647px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:116px"> <p>字段名称</p> </th> <th style="width:115px"> <p>字段类型</p> </th> <th style="width:217px"> <p>字段描述</p> </th> <th style="width:171px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:116px"> <p>inputStream</p> </td> <td style="width:115px"> <p>InputStream</p> </td> <td style="width:217px"> <p>文件加密流</p> </td> <td style="width:171px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(22)decryptFile(解密文件)</strong></p> <p><strong>接口描述</strong></p> <p>客户端解密是指用户从OBS服务器获取密文后,在客户端进行数据解密。</p> <p><strong>请求参数</strong></p> <table style="width:654px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:73px"> <p>参数名称</p> </th> <th style="width:63px"> <p>参数类型</p> </th> <th style="width:80px"> <p>是否必须</p> </th> <th style="width:186px"> <p>参数描述</p> </th> <th style="width:218px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:73px"> <p>file</p> </td> <td style="width:63px"> <p>File</p> </td> <td style="width:80px"> <p>true</p> </td> <td style="width:186px"> <p>文件对象</p> </td> <td style="width:218px"> <p>-</p> </td> </tr> <tr> <td style="width:73px"> <p>keySource</p> </td> <td style="width:63px"> <p>String</p> </td> <td style="width:80px"> <p>true</p> </td> <td style="width:186px"> <p>加密文件用的密钥</p> </td> <td style="width:218px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:654px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:107px"> <p>字段名称</p> </th> <th style="width:131px"> <p>字段类型</p> </th> <th style="width:260px"> <p>字段描述</p> </th> <th style="width:129px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:107px"> <p>inputStream</p> </td> <td style="width:131px"> <p>InputStream</p> </td> <td style="width:260px"> <p>文件解密流</p> </td> <td style="width:129px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(23)decryptInputStream(解密文件流)</strong></p> <p><strong>接口描述</strong></p> <p>客户端解密是指用户从OBS服务器获取密文后,在客户端进行数据解密。</p> <p><strong>请求参数</strong></p> <table style="width:639px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:95px"> <p><strong>参数名称</strong></p> </th> <th style="width:89px"> <p><strong>参数类型</strong></p> </th> <th style="width:98px"> <p><strong>是否必须</strong></p> </th> <th style="width:233px"> <p><strong>参数描述</strong></p> </th> <th style="width:88px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:95px"> <p>inputStream</p> </td> <td style="width:89px"> <p>InputStream</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:233px"> <p>文件流</p> </td> <td style="width:88px"> <p>-</p> </td> </tr> <tr> <td style="width:95px"> <p>keySource</p> </td> <td style="width:89px"> <p>String</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:233px"> <p>加密文件用的密钥</p> </td> <td style="width:88px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:644px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:107px"> <p>字段名称</p> </th> <th style="width:175px"> <p>字段类型</p> </th> <th style="width:253px"> <p>字段描述</p> </th> <th style="width:82px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:107px"> <p>inputStream</p> </td> <td style="width:175px"> <p>InputStream</p> </td> <td style="width:253px"> <p>文件解密流</p> </td> <td style="width:82px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(24)getImageView(图片格式转换)</strong></p> <p><strong>接口描述</strong></p> <p>客户端解密是指用户从OBS服务器获取密文后,在客户端进行数据解密。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:90px"> <p>参数名称</p> </th> <th style="width:80px"> <p>参数类型</p> </th> <th style="width:72px"> <p>是否必须</p> </th> <th style="width:445px"> <p>参数描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:90px"> <p>bucket</p> </td> <td style="width:80px"> <p>String</p> </td> <td style="width:72px"> <p>true</p> </td> <td style="width:445px"> <p>保存对象的 bucket 名称</p> </td> </tr> <tr> <td style="width:90px"> <p>objectKey</p> </td> <td style="width:80px"> <p>String</p> </td> <td style="width:72px"> <p>true</p> </td> <td style="width:445px"> <p>对象 Key</p> </td> </tr> <tr> <td style="width:90px"> <p>mode</p> </td> <td style="width:80px"> <p>String</p> </td> <td style="width:72px"> <p>true</p> </td> <td style="width:445px"> <p>缩放方式,有效值 0~5。</p> <ul> <li><strong>0</strong>:限定缩略图的长边最多为 ,短边最多为 ,进行等比缩放,不裁剪。如果只指定 w 参数则表示限定长边(短边自适应),只指定 h 参数则表示限定短边(长边自适应)。</li> <li><strong>1</strong>:限定缩略图的宽最少为 ,高最少为 ,进行等比缩放,居中裁剪。转后的缩略图通常恰好是 x 的大小(有一个边缩放的时候会因为超出矩形框而被裁剪掉多余部分)。如果只指定 w 参数或只指定 h 参数,代表限定为长宽相等的正方图。</li> <li> <p><strong>2</strong>: 限定缩略图的宽最多为 ,高最多为 ,进行等比缩放,不裁剪。如果只指定 w 参数则表示限定宽(长自适应),只指定 h 参数则表示限定长(宽自适应)。它和模式0类似,区别只是限定宽和高,不是限定长边和短边。从应用场景来说,模式0适合移动设备上做缩略图,模式2适合PC上做缩略图。</p> </li> <li> <p><strong>3</strong>: 限定缩略图的宽最少为 ,高最少为 ,进行等比缩放,不裁剪。如果只指定 w 参数或只指定 h 参数,代表长宽限定为同样的值。你可以理解为模式1是模式3的结果再做居中裁剪得到的。</p> </li> <li> <p><strong>4</strong>:限定缩略图的长边最少为 ,短边最少为 ,进行等比缩放,不裁剪。如果只指定 w 参数或只指定 h 参数,表示长边短边限定为同样的值。这个模式很适合在手持设备做图片的全屏查看(把这里的长边短边分别设为手机屏幕的分辨率即可),生成的图片尺寸刚好充满整个屏幕(某一个边可能会超出屏幕)。</p> </li> <li> <p><strong>5</strong>: 限定缩略图的长边最少为 ,短边最少为 ,进行等比缩放,居中裁剪。如果只指定 w 参数或只指定 h 参数,表示长边短边限定为同样的值。同上模式4,但超出限定的矩形部分会被裁剪。 `width:` 图片宽度,非负数,有效值(0-6000)</p> <p>height:图片高度,非负数,有效值(0-6000)</p> <p>imageFormat: 图片格式(非必传),支持jpeg, tiff, gif, bmp, png</p> </li> </ul> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:710px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:105px"> <p>字段名称</p> </th> <th style="width:119px"> <p>字段类型</p> </th> <th style="width:363px"> <p>字段描述</p> </th> <th style="width:95px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:105px"> <p>s3object</p> </td> <td style="width:119px"> <p>S3Object</p> </td> <td style="width:363px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:95px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(25)getThumbnail (获取缩略图或视频截图)</strong></p> <p><strong>接口描述</strong></p> <p>根据自定义规则获取缩略图或视频截图,缩略图支持格式jpeg, tiff, gif, bmp, png,截图支持格式:` jpg和png,此法将占用一个Http连接,在Content读取完毕或显示关闭时释放连接。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:89px"> <p>参数名称</p> </th> <th style="width:74px"> <p>参数类型</p> </th> <th style="width:104px"> <p>是否必须</p> </th> <th style="width:421px"> <p>参数描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:89px"> <p>bucket</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:421px"> <p>保存对象的 bucket 名称</p> </td> </tr> <tr> <td style="width:89px"> <p>objectKey</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:421px"> <p>对象 Key</p> </td> </tr> <tr> <td style="width:89px"> <p>formatName</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:421px"> <p>适配规则名称: 作为条件从数据库获取对应的自定义规则,然后截取第一个/前的内容进行适配,若为imageView则是图片缩放,若为vframe,则是视频截图</p> </td> </tr> <tr> <td style="width:89px"> <p>rectify</p> </td> <td style="width:74px"> <p>String</p> </td> <td style="width:104px"> <p>false</p> </td> <td style="width:421px"> <p>是否需要校正`(&ldquo;true&rdquo;或&rdquo;false&rdquo;,非必传),只对视频截图进行校正,旋转90或270(只是宽和高的长度换,并不是真正的旋转)</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:719px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:80px"> <p>字段名称</p> </th> <th style="width:101px"> <p>字段类型</p> </th> <th style="width:434px"> <p>字段描述</p> </th> <th style="width:76px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:80px"> <p>s3object</p> </td> <td style="width:101px"> <p>S3Object</p> </td> <td style="width:434px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:76px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(26)getCutImage (图片剪切)</strong></p> <p><strong>接口描述</strong></p> <p>根据宽度和高度获取剪切图,先截取图片左边和上边,截取到一定大小后(比较小的时候),会截取四边,保留中间部分,当设定值大于图片实际宽、高时,会根据实际大小裁剪,支持 jpeg, tiff, gif, bmp, emf, exif, wmf, icon, png, memoryBmp, webp。此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> <p><strong>请求参数</strong></p> <table style="width:715px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:86px"> <p>参数名称</p> </th> <th style="width:79px"> <p>参数类型</p> </th> <th style="width:96px"> <p>是否必须</p> </th> <th style="width:253px"> <p>参数描述</p> </th> <th style="width:167px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:86px"> <p>bucket</p> </td> <td style="width:79px"> <p>String</p> </td> <td style="width:96px"> <p>true</p> </td> <td style="width:253px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:167px"> <p>-</p> </td> </tr> <tr> <td style="width:86px"> <p>objectKey</p> </td> <td style="width:79px"> <p>String</p> </td> <td style="width:96px"> <p>true</p> </td> <td style="width:253px"> <p>对象 Key</p> </td> <td style="width:167px"> <p>-</p> </td> </tr> <tr> <td style="width:86px"> <p>width</p> </td> <td style="width:79px"> <p>int</p> </td> <td style="width:96px"> <p>true</p> </td> <td style="width:253px"> <p>图片宽度,非负数,有效值(0-6000)</p> </td> <td style="width:167px"> <p>-</p> </td> </tr> <tr> <td style="width:86px"> <p>height</p> </td> <td style="width:79px"> <p>int</p> </td> <td style="width:96px"> <p>true</p> </td> <td style="width:253px"> <p>图片高度,非负数,有效值(0-6000)</p> </td> <td style="width:167px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:713px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:101px"> <p>字段名称</p> </th> <th style="width:115px"> <p>字段类型</p> </th> <th style="width:344px"> <p>字段描述</p> </th> <th style="width:125px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:101px"> <p>s3object</p> </td> <td style="width:115px"> <p>S3Object</p> </td> <td style="width:344px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:125px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(27)getImageInfo(获取图片信息)</strong></p> <p><strong>接口描述</strong></p> <p>获取指定图片信息。</p> <p><strong>请求参数</strong></p> <table style="width:695px"> <caption>&nbsp;</caption> <thead> <tr> <th> <p>参数名称</p> </th> <th style="width:83px"> <p>参数类型</p> </th> <th style="width:72px"> <p>是否必须</p> </th> <th style="width:287px"> <p>参数描述</p> </th> <th style="width:157px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>bucket</p> </td> <td style="width:83px"> <p>String</p> </td> <td style="width:72px"> <p>true</p> </td> <td style="width:287px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:157px"> <p>-</p> </td> </tr> <tr> <td> <p>objectKey</p> </td> <td style="width:83px"> <p>String</p> </td> <td style="width:72px"> <p>true</p> </td> <td style="width:287px"> <p>对象 Key</p> </td> <td style="width:157px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:687px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:123px"> <p>字段名称</p> </th> <th style="width:170px"> <p>字段类型</p> </th> <th style="width:369px"> <p>字段描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:123px"> <p>imageInfoStr</p> </td> <td style="width:170px"> <p>InputStream</p> </td> <td style="width:369px"> <p>图片信息,<strong>json</strong>格式字符串,示例如下:</p> <pre> <code>{"ColorModel": "rgb", //颜色模式   "Format": "jpeg", //图片格式   "FrameNumber": 0, //缩放方式,与 mode 一样   "Height": 1707,   "Width": 963 }</code></pre> </td> </tr> </tbody> </table> <p><strong>(28)transCodingMedia(媒体转码)</strong></p> <p><strong>接口描述</strong></p> <p>媒体转码,此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> <p><strong>请求参数</strong></p> <table style="width:688px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:93px"> <p>参数名称</p> </th> <th style="width:73px"> <p>参数类型</p> </th> <th style="width:87px"> <p>是否必须</p> </th> <th style="width:270px"> <p>参数描述</p> </th> <th style="width:130px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:93px"> <p>bucket</p> </td> <td style="width:73px"> <p>String</p> </td> <td style="width:87px"> <p>true</p> </td> <td style="width:270px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:130px"> <p>-</p> </td> </tr> <tr> <td style="width:93px"> <p>objectKey</p> </td> <td style="width:73px"> <p>String</p> </td> <td style="width:87px"> <p>true</p> </td> <td style="width:270px"> <p>对象 Key</p> </td> <td style="width:130px"> <p>-</p> </td> </tr> <tr> <td style="width:93px"> <p>format</p> </td> <td style="width:73px"> <p>String</p> </td> <td style="width:87px"> <p>true</p> </td> <td style="width:270px"> <p>转码后对象的格式</p> </td> <td style="width:130px"> <p>-</p> </td> </tr> <tr> <td style="width:93px"> <p>notifyURL</p> </td> <td style="width:73px"> <p>String</p> </td> <td style="width:87px"> <p>true</p> </td> <td style="width:270px"> <p>转码JOB的通知URL</p> </td> <td style="width:130px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:681px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:88px"> <p>字段名称</p> </th> <th style="width:87px"> <p>字段类型</p> </th> <th style="width:366px"> <p>字段描述</p> </th> <th style="width:112px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:88px"> <p>s3object</p> </td> <td style="width:87px"> <p>S3Object</p> </td> <td style="width:366px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:112px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(29)getVedioFrame(视频截图)</strong></p> <p><strong>接口描述</strong></p> <p>获取视频截图,此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> <p><strong>请求参数</strong></p> <table style="width:673px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:76px"> <p>参数名称</p> </th> <th style="width:62px"> <p>参数类型</p> </th> <th style="width:138px"> <p>是否必须</p> </th> <th style="width:200px"> <p>参数描述</p> </th> <th style="width:160px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:76px"> <p>bucket</p> </td> <td style="width:62px"> <p>String</p> </td> <td style="width:138px"> <p>true</p> </td> <td style="width:200px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:160px"> <p>-</p> </td> </tr> <tr> <td style="width:76px"> <p>objectKey</p> </td> <td style="width:62px"> <p>String</p> </td> <td style="width:138px"> <p>true</p> </td> <td style="width:200px"> <p>对象 Key</p> </td> <td style="width:160px"> <p>-</p> </td> </tr> <tr> <td style="width:76px"> <p>format</p> </td> <td style="width:62px"> <p>String</p> </td> <td style="width:138px"> <p>true</p> </td> <td style="width:200px"> <p>截图的格式、尺寸</p> </td> <td style="width:160px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:667px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:82px"> <p>字段名称</p> </th> <th style="width:116px"> <p>字段类型</p> </th> <th style="width:343px"> <p>字段描述</p> </th> <th style="width:98px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:82px"> <p>s3object</p> </td> <td style="width:116px"> <p>S3Object</p> </td> <td style="width:343px"> <p>包含对象流的 S3Object 实例,需读取 Content 自行保存</p> </td> <td style="width:98px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(30)getMediaInfo(获取媒体信息)</strong></p> <p><strong>接口描述</strong></p> <p>获取视频截图,此方法将占用一个 Http 连接,在 Content 读取完毕或显示关闭时释放连接。</p> <p><strong>请求参数</strong></p> <table style="width:669px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:77px"> <p>参数名称</p> </th> <th style="width:65px"> <p>参数类型</p> </th> <th style="width:74px"> <p>是否必须</p> </th> <th style="width:325px"> <p>参数描述</p> </th> <th style="width:93px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:77px"> <p>bucket</p> </td> <td style="width:65px"> <p>String</p> </td> <td style="width:74px"> <p>true</p> </td> <td style="width:325px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:93px"> <p>-</p> </td> </tr> <tr> <td style="width:77px"> <p>objectKey</p> </td> <td style="width:65px"> <p>String</p> </td> <td style="width:74px"> <p>true</p> </td> <td style="width:325px"> <p>对象 Key</p> </td> <td style="width:93px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:165px"> <p>字段名称</p> </th> <th style="width:137px"> <p>字段类型</p> </th> <th style="width:390px"> <p>字段描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:165px"> <p>mediaInfoStr</p> </td> <td style="width:137px"> <p>String</p> </td> <td style="width:390px"> <p>媒体对象的信息,<strong>json</strong>格式字符串,示例如下:</p> <pre> <code>{ "streams": [{ "index": 0, "codec_name": "mjpeg", "codec_long_name": "MJPEG (Motion JPEG)", "codec_type": "video", "codec_time_base": "1/25", "codec_tag_string": "[0][0][0][0]", "codec_tag": "0x0000", "width": 3885, "height": 2764, "has_b_frames": 0, "sample_aspect_ratio": "1:1", "display_aspect_ratio": "3885:2764", "pix_fmt": "yuvj444p", "level": -99, "color_range": "pc", "color_space": "bt470bg", "chroma_location": "center", "refs": 1, "r_frame_rate": "25/1", "avg_frame_rate": "0/0", "time_base": "1/25", "bits_per_raw_sample": "8", "disposition": { "default": 0, "dub": 0, "original": 0, "comment": 0, "lyrics": 0, "karaoke": 0, "forced": 0, "hearing_impaired": 0, "visual_impaired": 0, "clean_effects": 0, "attached_pic": 0 } }], "format": { "filename": "/wls/appsystems/csp-media/data/0b5f036604ea452fbc26810946293644xiaoming-bucket-0009.46a5476297c740239820ed4d64e256a6$002", "nb_streams": 1, "nb_programs": 0, "format_name": "jpeg_pipe", "format_long_name": "piped jpeg sequence", "size": "1659948", "probe_score": 6 } }</code></pre> </td> </tr> </tbody> </table> <p><strong>(31)queryMediaByCKs(获取转码记录)</strong></p> <p><strong>接口描述</strong></p> <p>获取 media 转码记录,用于查询转码进度<strong>。</strong></p> <p><strong>请求参数</strong></p> <table style="width:647px"> <caption>&nbsp;</caption> <thead> <tr> <th> <p>参数名称</p> </th> <th style="width:78px"> <p>参数类型</p> </th> <th style="width:98px"> <p>是否必须</p> </th> <th style="width:226px"> <p>参数描述</p> </th> <th style="width:120px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>bucket</p> </td> <td style="width:78px"> <p>String</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:226px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:120px"> <p>-</p> </td> </tr> <tr> <td> <p>convertedKeys</p> </td> <td style="width:78px"> <p>List</p> </td> <td style="width:98px"> <p>true</p> </td> <td style="width:226px"> <p>转换后新生成的对象Key集合</p> </td> <td style="width:120px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:689px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:162px"> <p>字段名称</p> </th> <th style="width:149px"> <p>字段类型</p> </th> <th style="width:355px"> <p>字段描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:162px"> <p>mediaResultStr</p> </td> <td style="width:149px"> <p>String</p> </td> <td style="width:355px"> <p>音视频转码进度信息,json字符串,示例如下:</p> <pre> <code>[{ "bucket": "yourBucket", "finishTime": "2017-07-14 13:56:54", "submitTime": "2017-07-14 13:56:53", "startTime": "2017-07-14 13:56:53", "state": "Error", // 状态,用于反应转码进度 "oriObjectKey": "46a5476297c740239820ed4d64e256a6$002", // 原始key "message": "desFile.exists: false", // 失败原因 "convertedKey": "yourConvertedKey " }]</code></pre> </td> </tr> </tbody> </table> <p><strong>(32)deleteMediaByCK(删除转码信息)</strong></p> <p><strong>接口描述</strong></p> <p>根据转换后新生成的 key 删除 media 转码记录及转码后的 object。</p> <p><strong>请求参数</strong></p> <table style="width:636px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:95px"> <p>参数名称</p> </th> <th style="width:86px"> <p>参数类型</p> </th> <th style="width:70px"> <p>是否必须</p> </th> <th style="width:214px"> <p>参数描述</p> </th> <th style="width:137px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:95px"> <p>bucket</p> </td> <td style="width:86px"> <p>String</p> </td> <td style="width:70px"> <p>true</p> </td> <td style="width:214px"> <p>保存对象的 bucket 名称</p> </td> <td style="width:137px"> <p>-</p> </td> </tr> <tr> <td style="width:95px"> <p>convertedKey</p> </td> <td style="width:86px"> <p>String</p> </td> <td style="width:70px"> <p>true</p> </td> <td style="width:214px"> <p>转换后新生成的对象 Key</p> </td> <td style="width:137px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <p>无</p> <p><strong>(33)pfop(图片处理,音视频转码持久化处理(PFOP接口))</strong></p> <p><strong>接口描述</strong></p> <p>图片、音视频异步处理并持久化。</p> <p><strong>请求参数</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width: 122px;"> <p>参数名称</p> </th> <th style="width: 111px;"> <p>参数类型</p> </th> <th style="width: 104px;"> <p>是否必须</p> </th> <th style="width: 275px;"> <p>参数描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:122px"> <p>sourceType</p> </td> <td style="width:111px"> <p>SourceType</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:275px"> <p style="text-align:center">媒体类型</p> </td> </tr> <tr> <td style="width:122px"> <p>srcBucket</p> </td> <td style="width:111px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:275px"> <p style="text-align:center">源bucket</p> </td> </tr> <tr> <td style="width:122px"> <p>srcKey</p> </td> <td style="width:111px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:275px"> <p style="text-align:center">源key</p> </td> </tr> <tr> <td style="width:122px"> <p>force</p> </td> <td style="width:111px"> <p>boolean</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:275px"> <p style="text-align:center">指定当处理后的KEY已经存在于bucket中是否覆盖已经存在的对象。为true时覆盖。</p> </td> </tr> <tr> <td style="width:122px"> <p>notifyUrl</p> </td> <td style="width:111px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:275px"> <p style="text-align:center">异步处理完成后通知客户的地址。</p> </td> </tr> <tr> <td style="width:122px"> <p>ops</p> </td> <td style="width:111px"> <p>String</p> </td> <td style="width:104px"> <p>true</p> </td> <td style="width:275px"> <p>持久处理操作列表,用 | 分隔,如:</p> <pre> <code>avthumb/wma; saveas/ZGRhc2U6cGxhaW50ZXh0LWZyYW1lLTFa|avthumb/mp3;</code></pre> <p>saveas/ZGRhc2U6cGxhaW50ZXh0LWZyYW1lMVU= 是将源视频文件转成wma并以KEY mywma 存储在bucket ddase下;转成mp3并以KEY mymp3 存储在bucket ddase下。</p> <p>一个持久处理包括处理命令和存储设置,用 ; 分隔。存储设置以saveas/开头,后接按Base64编码后的字符串。若不指定saveas,则会由obs生成一个key并保存在srcBucket下。</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:713px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:71px"> <p>字段名称</p> </th> <th style="width:82px"> <p>字段类型</p> </th> <th style="width:494px"> <p>字段描述</p> </th> <th style="width:38px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:71px"> <p>resultStr</p> </td> <td style="width:82px"> <p>String</p> </td> <td style="width:494px"> <p>Pfop异步操作流水号JSON,用于查询操作进度。</p> <pre> <code>{"persistentId": "0443351fbb564de38542f8c092d18389fe9f8345f3ca"}</code></pre> </td> <td style="width:38px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>(34)Prefop(PFOP持久化处理结果查询)</strong></p> <p><strong>接口描述</strong></p> <p>操作pfop操作进度和操作结果。</p> <p><strong>请求参数</strong></p> <table style="width:571px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:91px"> <p>参数名称</p> </th> <th style="width:67px"> <p>参数类型</p> </th> <th style="width:97px"> <p>是否必须</p> </th> <th style="width:199px"> <p>参数描述</p> </th> <th style="width:81px"> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td style="width:91px"> <p>persistentId</p> </td> <td style="width:67px"> <p>String</p> </td> <td style="width:97px"> <p>true</p> </td> <td style="width:199px"> <p>异步处理流水号</p> </td> <td style="width:81px"> <p>-</p> </td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table style="width:692px"> <caption>&nbsp;</caption> <thead> <tr> <th style="width:88px"> <p>字段名称</p> </th> <th style="width:113px"> <p>字段类型</p> </th> <th style="width:469px"> <p>字段描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:88px"> <p>resultStr</p> </td> <td style="width:113px"> <p>String</p> </td> <td style="width:469px"> <p>查询响应为content-type为application/json的字符串,示例如下:</p> <pre> <code>{ "id":"0f7edf1e508e4620b8784e5ca4dd7554fe9f82ff1b31", "notifyState":"0", "desc":"The fop was completed successfully", "notifyTryTimes":4, "items":[{ "cmd":"convert/900/600/png/75", "desc":"success", "error":"", "hash":"\"b2e18e821063c7713e497dd0c9a6a7e3\"", "code":0, "key":"ZGRhc2U6ZGRhc2VhYzRlZjIyOGQxNDQ0MDRiYmM5ZDYyNzE2ZWU5M2ZhNjA="}, {"cmd":"thumb/0/700/800/png/75", "desc":"success", "error":"", "hash":"\"ab63afa8d90fc944ed437d91d8d10b81\"", "code":0, "key":"ZGRhc2U6ZGRhc2U2YjIyOGQ0MWZjZmQ0NTllOGQ2OTRkYTgzNDJmYjkyYzA="}, {"cmd":"imageslim", "desc":"success", "error":"", "hash":"\"4e3cd2637001ce77d95928a0e961548f\"", "code":0, "key":"ZGRhc2U6ZGRhc2U0MTcwZWQ0NDc4NzU0NzNkYjUwM2Q5NzU2OTUxN2Y5NTA=" }], "inputKey":"1222_1-test", "inputBucket":"ddase", "code":0, "notifyResponseCode":200 }</code></pre> </td> </tr> </tbody> </table> <p><strong>查询结果说明:</strong></p> <table> <caption>&nbsp;</caption> <thead> <tr> <th style="width:172px"> <p>名称</p> </th> <th style="width:72px"> <p>必填</p> </th> <th style="width:448px"> <p>描述</p> </th> </tr> </thead> <tbody> <tr> <td style="width:172px"> <p>code</p> </td> <td style="width:72px"> <p>是</p> </td> <td style="width:448px"> <p>状态码 0:成功,1:正在处理,2:处理成功但PFOP操作列表部分或全部失败,3:处理失败</p> </td> </tr> <tr> <td style="width:172px"> <p>desc</p> </td> <td style="width:72px"> <p>否</p> </td> <td style="width:448px"> <p>对应code的描述</p> </td> </tr> <tr> <td style="width:172px"> <p>id</p> </td> <td style="width:72px"> <p>是</p> </td> <td style="width:448px"> <p>PFOP持久处理流水号</p> </td> </tr> <tr> <td style="width:172px"> <p>inputBucket</p> </td> <td style="width:72px"> <p>是</p> </td> <td style="width:448px"> <p>源文件所在bucket</p> </td> </tr> <tr> <td style="width:172px"> <p>inputKey</p> </td> <td style="width:72px"> <p>是</p> </td> <td style="width:448px"> <p>源文件所在key</p> </td> </tr> <tr> <td style="width:172px"> <p>items</p> </td> <td style="width:72px"> <p>否</p> </td> <td style="width:448px"> <p>持久操作列表(仅当code码为0/2时该字段有值),与通知内容中的items一致,请参阅 通知内容说明</p> </td> </tr> <tr> <td style="width:172px"> <p>notifyState</p> </td> <td style="width:72px"> <p>否</p> </td> <td style="width:448px"> <p>通知状态 0:成功,1:等待通知,2:通知失败,3:通知彻底失败并不再尝试通知。为空表示处理还未完成。</p> </td> </tr> <tr> <td style="width:172px"> <p>notifyResponseCode</p> </td> <td style="width:72px"> <p>否</p> </td> <td style="width:448px"> <p>通知客户端的响应码,当响应为200时被认为通知成功</p> </td> </tr> <tr> <td style="width:172px"> <p>notifyResponseBody</p> </td> <td style="width:72px"> <p>否</p> </td> <td style="width:448px"> <p>通知响应,当通知失败时为失败相关的信息</p> </td> </tr> <tr> <td style="width:172px"> <p>notifyTryTimes</p> </td> <td style="width:72px"> <p>否</p> </td> <td style="width:448px"> <p>通知客户端已经尝试的次数</p> </td> </tr> </tbody> </table> <p>常用实现场景</p> <p><strong>场景描述</strong></p> <p>平安云ECS主机上传,生成公网可访问的下载链接。</p> <p><strong>实现过程</strong></p> <p>初始化上传service</p> <pre> RadosgwService uploadService = RadosgwServiceFactory.getFromConfigFile(<span style="color:#2a00ff">&quot;obs_ecs_upload.properties&quot;</span>);</pre> <p>初始化生成公网链接service</p> <pre> RadosgwService urlService=RadosgwServiceFactory.getFromConfigFile(<span style="color:#2a00ff">&quot;obs_ext_url.properties&quot;</span>);</pre> <p>调用上传服务</p> <pre> uploadService.putObject(<span style="color:#2a00ff">&quot;bucket&quot;</span>, <span style="color:#2a00ff">&quot;objectKey&quot;</span>, <strong>new</strong> File(<span style="color:#2a00ff">&quot;filePath&quot;</span>));</pre> <p>生成公网下载链接</p> <pre> String url=urlService.getSignedUrl(<span style="color:#2a00ff">&quot;bucket&quot;</span>, <span style="color:#2a00ff">&quot;objectKey&quot;</span>);</pre> <p>配置文件信息</p> <table> <caption>&nbsp;</caption> <thead> <tr> <th>obs_ecs_upload.properties</th> <th>obs_ext_url.properties</th> </tr> </thead> <tbody> <tr> <td> <p>access_id= Access Key ID which have upload rights</p> <p>security_id=Access Key Secret which have upload rights</p> <p>rgw_addr=obs-cn-shenzhen-internal.cloud.papub</p> </td> <td> <p>access_id= Access Key ID which have download rights</p> <p>security_id=Access Key Secret which have download rights</p> <p>rgw_addr=obs-cn-shenzhen.pinganyun.com</p> </td> </tr> </tbody> </table>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题