平安云 - 云以致用智造未来

API 描述

1. 上传文件 接口描述 上传文件 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> PUT </td> <td> http:// {bucket.host}/{key} http://{host}/{bucket}/{key} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名称 见资源术语 </td> </tr> <tr> <td> {key} </td> <td> Key名称 见资源术语 </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td>   </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   2. 分片上传文件 接口描述 一次分片上传，需要三个子步骤： <ul> <li>初始化分片上传</li> <li>上传每个分片</li> <li>完成分片上传</li> </ul> （1）初始化分片上传 用于获取一个上传ID，在后续的步骤中（上传每一分片和完成分片上传），请求中都需要带上此ID作为请求参数。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> POST </td> <td> {bucket.host}/{key}?uploads {host}/{bucket}/{key}?uploads </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名称 见资源术语 </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 见响应示例 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table> 请求示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> POST /xiaoming-bucket-0009/mykey?uploads HTTP/1.1 Authorization: AWS 5NE0EMKT1XAIF1WRUSDB:uFlfwIpe2yPSbtVhF6QjBYHTmL0=, Content-Type: application/zip, Date: Wed, 03 Jan 2018 01:56:39 GMT </td> </tr> </tbody> </table> 响应示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> <?xml version="1.0" encoding="UTF-8"?> <InitiateMultipartUploadResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Bucket>xiaoming-bucket-0009</Bucket> <Key>mykey</Key> <UploadId>2~fj31Nbo8jDMALTOjMOoq_WZe1iyTOyw</UploadId> </InitiateMultipartUploadResult> </td> </tr> </tbody> </table> （2）上传每个分片 将分片的字节流作为请求的body。每个分片（除了最后一个分片）的大小必须不小于5M，分片总数不大于10000片。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> PUT </td> <td> http://{bucket.host}/{key}?partNumber={partNumber} &uploadId={uploadId} http://{host}/{bucket}/{key}?partNumber={partNumber} &uploadId={uploadId} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 入参 </td> <td> partNumber </td> <td> 分片编号。第1片编号为1，以后每片编号加1 </td> </tr> <tr> <td> uploadId </td> <td> 上传ID，来源于初始化上传返回的ID </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名称 见资源术语 </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 请记录头部中的ETag值，该值在最后调用完成分片时会用到。注意，在公网环境/代理环境中响应头部的ETag名称可能会被篡改为Etag或etag，获取时请注意大小写 见响应示例 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table> 请求示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> PUT /xiaoming-bucket-0009/mykey?partNumber=1&uploadId=2~wox3UUmC3CtiVDZO7Ktnnia6vROLudY HTTP/1.1 Authorization: AWS 5NE0EMKT1XAIF1WRUSDB:6QcN+fHGHFclO5WvcdxfaznskFc= Content-MD5: sEj3I1ECjtaOEVlpUuKhzA== Content-Type: application/zip Date: Wed, 03 Jan 2018 02:21:05 GMT </td> </tr> </tbody> </table> 响应示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> HTTP/1.1 200 OK ETag: "b048f72351028ed68e11596952e2a1cc" </td> </tr> </tbody> </table> （3）完成分片上传 将每次分片响应的ETag值拼装成以下的XMl作为请求的body，PartNumber从1开始： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> <CompleteMultipartUpload> <Part> <PartNumber>1</PartNumber> <ETag>b048f72351028ed68e11596952e2a1cc</ETag> </Part> <Part> <PartNumber>2</PartNumber> <ETag>43144f8ff83a9379222c579078b96042</ETag> </Part> </CompleteMultipartUpload> </td> </tr> </tbody> </table> 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> POST </td> <td> http:// {bucket.host}/{key}?uploadId={uploadId} http://{host}/{bucket}/{key}?uploadId={uploadId} </td> <td> 说明 </td> </tr> <tr> <td> 入参 </td> <td> uploadId </td> <td> 上传ID，来源于初始化上传返回的ID </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名称 </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td>   </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table> 请求示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> POST /xiaoming-bucket-0009/mykey?uploadId=2~R8TAtOVsxcxzw8_pQI5g8WgSIz81Vqn HTTP/1.1 Authorization: AWS 5NE0EMKT1XAIF1WRUSDB:LC1TqLtmbSXwylvokg3Wubo5Sgo= Date: Wed, 03 Jan 2018 02:36:36 GMT Content-Type: application/octet-stream <CompleteMultipartUpload> <Part> <PartNumber>1</PartNumber> <ETag>b048f72351028ed68e11596952e2a1cc</ETag> </Part> <Part> <PartNumber>2</PartNumber> <ETag>43144f8ff83a9379222c579078b96042</ETag> </Part> </CompleteMultipartUpload> </td> </tr> </tbody> </table> 响应示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> HTTP/1.1 200 OK Content-Type: application/xml <?xml version="1.0" encoding="UTF-8"?> <CompleteMultipartUploadResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Bucket>xiaoming-bucket-0009</Bucket> <Key>mykey</Key> <ETag>cca15715f657c57c4e1051f727b7d7c4-2</ETag> </CompleteMultipartUploadResult> </td> </tr> </tbody> </table> （4）取消分片上传 可以删除该某一上传ID相关的未完成的片，以释放占用OBS存储空间。 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> DELETE </td> <td> http:// {bucket.host}/{key}?uploadId={uploadId} http://{host}/{bucket}/{key}?uploadId={uploadId} </td> <td> 说明 </td> </tr> <tr> <td> 入参 </td> <td> uploadId </td> <td> 上传ID，来源于初始化上传返回的ID </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名称 </td> </tr> <tr> <td> {key:.*} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td>   </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table> 请求示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> DELETE /xiaoming-bucket-0009/mykey?uploadId=2~SNGTH88-FcDMa7A7cPUnyc4DtNYjdLx HTTP/1.1 Authorization: AWS 5NE0EMKT1XAIF1WRUSDB:ObFa4+N5bB/lDRUfbAAIHUUGGtI= Date: Wed, 03 Jan 2018 02:49:11 GMT Content-Type: application/x-www-form-urlencoded </td> </tr> </tbody> </table> 响应示例 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> HTTP/1.1 204 No Content Content-Type: text/plain </td> </tr> </tbody> </table>   3. 下载文件 接口描 述 下载文件 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> GET </td> <td> http://{bucket.host}/{key} http://{host}/{bucket}/{key} </td> <td> 说明 </td> </tr> <tr> <td rowspan="4"> 入参 </td> <td> AWSAccessKeyId </td> <td> 租户AK(非必填) </td> </tr> <tr> <td> Expires </td> <td> 从1990-01-01 00:00:00 GMT到截止有效期的秒数(非必填) </td> </tr> <tr> <td> Signature </td> <td> 签名串(非必填) </td> </tr> <tr> <td> response-content-disposition </td> <td> 下载文件重命名(非必填) </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名字，格式：小写字母、数字、中划线（不支持中文）,不能以中横线开头或结尾,不能以-s数字结尾命名规范：RSMS子系统英文简称-环境-自定义/流水码,环境:用dev代表开发测试环境,prd代表生产环境和灾备环境 </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 对象流 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table> 注意，当通过签名URL下载文件时，入参中的AWSAccessKeyId，Expires，Signature为必填；否则，头参Authorization，Content-Type，Date为必填，且不要填写入参AWSAccessKeyId。   4. 获取Object信息 接口描述 获取object信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> HEAD </td> <td> http://{bucket.host}/{key} http://{host}/{bucket}/{key} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名字 </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> Object信息，请从response header里获取object相关信息包括Content-Type, Content-Length, ETag, Date。注意，用户自定义的metadata，其KEY值前会被添加字符串“x-amz-meta-”。比如，用户定义的color，响应的header中会以x-amz-meta-color呈现。 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   5. 删除Object 接口描述 删除object 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> DELETE </td> <td> http://{bucket.host}/{key} http://{host}/{bucket}/{key} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td> Bucket名字，格式：小写字母、数字、中划线（不支持中文）,不能以中横线开头或结尾,不能以-s数字结尾命名规范：RSMS子系统英文简称-环境-自定义/流水码,环境:用dev代表开发测试环境,prd代表生产环境和灾备环境 </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td>   </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   6. 图片格式转换 接口描述 图片格式转换 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> GET </td> <td> http://{bucket.host} /{key} /imageView/{mode}/w/{width}/h/{height}/format/{format} http://{host} /{bucket}/{key} /imageView/{mode}/w/{width}/h/{height}/format/{format}   </td> <td> 说明 </td> </tr> <tr> <td rowspan="6"> 入参 </td> <td> {bucket} </td> <td>   </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td> {mode}/ </td> <td> 缩放方式，有效值0-5 </td> </tr> <tr> <td> {width} </td> <td> 图片宽度，有效值0-6000（非必传） </td> </tr> <tr> <td> {height} </td> <td> 图片高度，有效值0-6000（非必传） </td> </tr> <tr> <td> {format} </td> <td> 图片格式(非必传)，支持jpeg, tiff, gif, bmp, png </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 图片流 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table> 注：参数width和height至少需传入一个，不能同时为0 所有访问路径： http://{host}/download/{bucket}/{key:.*}/imageView/{mode}/w/{width}/h/{height}/format/{format}, http://{host}/{bucket}/{key:.*}/imageView/{mode}/w/{width}/h/{height}/format/{format}, http://{host}/download/{bucket}/{key:.*}/imageView/{mode}/h/{height}/format/{format}, http://{host}/{bucket}/{key:.*}/imageView/{mode}/h/{height}/format/{format}, http://{host}/download/{bucket}/{key:.*}/imageView/{mode}/w/{width}/format/{format}, http://{host}/{bucket}/{key:.*}/imageView/{mode}/w/{width}/format/{format}, http://{host}/download/{bucket}/{key:.*}/imageView/{mode}/w/{width}/h/{height}, http://{host}/{bucket}/{key:.*}/imageView/{mode}/w/{width}/h/{height}, http://{host}/download/{bucket}/{key:.*}/imageView/{mode}/w/{width}, http://{host}/{bucket}/{key:.*}/imageView/{mode}/w/{width}, http://{host}/download/{bucket}/{key:.*}/imageView/{mode}/h/{height}, http://{host}/{bucket}/{key:.*}/imageView/{mode}/h/{height}   7. 剪切图 接口描述 剪切图 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> GET </td> <td> http://{bucket.host}/{key}/cut/{width}/{height} http://{host}/{bucket}/{key}/cut/{width}/{height} </td> <td> 说明 </td> </tr> <tr> <td rowspan="4"> 入参 </td> <td> {bucket} </td> <td> Bucket名字，格式：小写字母、数字、中划线（不支持中文）,不能以中横线开头或结尾,不能以-s数字结尾命名规范：RSMS子系统英文简称-环境-自定义/流水码,环境:用dev代表开发测试环境,prd代表生产环境和灾备环境 </td> </tr> <tr> <td> {key } </td> <td> 对象key </td> </tr> <tr> <td> {width} </td> <td> 图片宽度，有效值0-6000 </td> </tr> <tr> <td> {height} </td> <td> 图片高度，有效值0-6000 </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 图片流 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   8. 获取指定图片信息 接口描述 获取指定图片信息 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> PUT </td> <td> http://{bucket.host}/imageInfo/{key} http://{host}/imageInfo/{bucket}/{key} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 路径参数 </td> <td> {bucket} </td> <td>   </td> </tr> <tr> <td> {key} </td> <td> 对象key </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> {ColorModel, Format, FrameNumber, Height, Width } </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   9. 删除转码记录及转换后的Object 接口描述 删除转码记录及转换后的Object 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> PUT </td> <td> http://{bucket.host}/deleteByCK ?bucket={bucket} &convertedKey={convertedKey} http://{host}/deleteByCK ?bucket={bucket} &convertedKey={convertedKey} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 入参 </td> <td> convertedKey </td> <td> 转换后新生成的对象Key </td> </tr> <tr> <td> bucket </td> <td>   </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 无 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   10. 获取media转码记录，用于查询转码进度 接口描述 获取media转码记录，用于查询转码进度 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> GET </td> <td> http://{bucket.host}/queryByCKs?bucket={bucket} &convertedKeys={convertedKeys} http://{host}/queryByCKs?bucket={bucket} &convertedKeys={convertedKeys} </td> <td> 说明 </td> </tr> <tr> <td rowspan="2"> 入参 </td> <td> convertedKeys </td> <td> 转换后新生成的对象Key集,通过逗号分割 如：key1,key2 </td> </tr> <tr> <td> bucket </td> <td>   </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> "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 "   </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>   11. 媒体转码和视频截图 接口描述 媒体转码和视频截图 请求参数 <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td>    POST </td> <td> http://{bucket.host}/pfop?bucket={bucket}&key={key} &sourceType={sourceType}&force={force} &fops={fops}&notifyURL={notifyURL} http://{host}/ pfop?bucket={bucket}&key={key} &sourceType={sourceType}&force={force} &fops={fops}&notifyURL={notifyURL} </td> <td> 说明 </td> </tr> <tr> <td rowspan="6"> 入参 </td> <td> bucket </td> <td> Bucket名字 </td> </tr> <tr> <td> key </td> <td> 对象key </td> </tr> <tr> <td> sourceType </td> <td> 源类型 如下： image、media </td> </tr> <tr> <td> fops </td> <td> 自定义的规则 </td> </tr> <tr> <td> force </td> <td> 是否覆盖原有的Key 默认为false </td> </tr> <tr> <td> notifyURL </td> <td> 转码JOB的通知URL（非必传） </td> </tr> <tr> <td rowspan="2"> 出参 </td> <td> 成功 </td> <td> 对象流 </td> </tr> <tr> <td> 失败 </td> <td> 异常信息 </td> </tr> </tbody> </table>

以上内容是否解决了您的问题？是否