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

Python SDK

1. 简介 <ul> <li>OBS Python SDK 适用于 Python3版本。</li> <li>本文档主要介绍 OBS Python SDK 的接口使用及注意事项。</li> <li>假设您是平安云用户，且已经开通了OBS服务。</li> <li>如果您还没有开通或者还不了解平安云 OBS 服务，请登录<a href="https://pinganyun.com/ssr/products/OBS" target="_blank">OBS产品主页</a>进行了解。</li> </ul> 2. SDK下载 Python SDK 开发包最新版本<a href="https://pcp-portal-sca.obs-cn-shenzhen.pinganyun.com/sdk%2Fobs-python-sdk-1.1.0.zip?response-content-disposition=attachment%3Bfilename%3Dobs-python-sdk-1.1.0.zip" target="_blank"> v1.1.0</a>。 3. API概览 <table> <caption> </caption> <thead> <tr> <th> API </th> <th> 描述 </th> </tr> </thead> <tbody> <tr> <td> put_object </td> <td> 以字符串/文件/网络流作为上传对象，若该bucket下存在该object_key则更新该对象，并支持添加自定义元数据。 </td> </tr> <tr> <td> put_object_multipart </td> <td> 对于大文件上传，可以切分成片上传。在以下情况下，应该考虑使用分片上传： <ul> <li>文件大于 100M</li> <li>网络环境差，上传易导致失败</li> </ul> 需要支持断点续传 </td> </tr> <tr> <td> get_object </td> <td> 下载指定对象 </td> </tr> </tbody> </table> 4. API描述 （1） put_object（上传字符串） 接口描述 以字符串为上传对象，若该bucket下存在该object_key则更新该对象，并支持添加自定义元数据。 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket_name </td> <td> string </td> <td> true </td> <td> 保存对象的 bucket名称 </td> <td> - </td> </tr> <tr> <td> object_key </td> <td> string </td> <td> true </td> <td> 对象 key，需自行实现策略保证同一 bucket 下 object_key 唯一, 不能为空，首字符不能为路径符“/” </td> <td> - </td> </tr> <tr> <td> data </td> <td> string </td> <td> true </td> <td> 待上传的字符串 </td> <td> - </td> </tr> <tr> <td> object_metadata </td> <td> ObjectMetadata </td> <td> false </td> <td> 可选参数，自定义元数据 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> putObjectResult </td> <td> PutObjectResult </td> <td> PutObjectResult返回对象 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> bucket_name = “YourBucketName” object_key = “YourObjectKey” upload_content = “YourContent” object_metadata = ObjectMetadata() object_metadata.add_user_metadata(“MetadataKey”,“MetadataValue”) ret = obs.put_object(bucket_name, object_key, upload_content，object_metadata) print(ret.get_e_tag())</pre> （2） put_object（上传文件） 接口描述 以文件对象为上传对象，若对象存在则更新，并支持添加自定义元数据。 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket_name </td> <td> string </td> <td> true </td> <td> 保存对象的 bucket名称 </td> <td> - </td> </tr> <tr> <td> object_key </td> <td> string </td> <td> true </td> <td> 对象 key，需自行实现策略保证同一 bucket 下 object_key 唯一, 不能为空，首字符不能为路径符“/” </td> <td> - </td> </tr> <tr> <td> data </td> <td> file </td> <td> true </td> <td> 待上传的文件对象 </td> <td> - </td> </tr> <tr> <td> object_metadata </td> <td> ObjectMetadata </td> <td> false </td> <td> 可选参数，自定义元数据 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> putObjectResult </td> <td> PutObjectResult </td> <td> PutObjectResult返回对象 </td> <td> - </td> </tr> </tbody> </table> 实例 样例1： <pre> bucket_name = “YourBucketName” object_key = “YourObjectKey” local_file_upload_path = “YourLocalUploadFilePath” with open(local_file_upload_path,"rb") as from_file: ret = obs.put_object(bucket_name, object_key, from_file) </pre> 样例2: 使用简单接口上传本地文件 <pre> bucket_name = “YourBucketName” object_key = “YourObjectKey” local_file_upload_path = “YourLocalUploadFilePath” ret = obs.put_object_from_file(bucket_name, object_key, local_file_upload_path) </pre> （3） put_object（上传网络流） 接口描述 以网络流为上传对象，若对象存在则更新，并支持添加自定义元数据。 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket_name </td> <td> string </td> <td> true </td> <td> 保存对象的 bucket名称 </td> <td> - </td> </tr> <tr> <td> object_key </td> <td> string </td> <td> true </td> <td> 对象 key，需自行实现策略保证同一 bucket 下 object_key 唯一, 不能为空，首字符不能为路径符“/” </td> <td> - </td> </tr> <tr> <td> data </td> <td> Input_stream </td> <td> true </td> <td> 待上传的文件对象 </td> <td> - </td> </tr> <tr> <td> object_metadata </td> <td> ObjectMetadata </td> <td> false </td> <td> 可选参数，自定义元数据 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> putObjectResult </td> <td> PutObjectResult </td> <td> PutObjectResult返回对象 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> import requests bucket_name = “YourBucketName” object_key = “YourObjectKey” input_stream = requests.get("http://alm.paic.com.cn/project/2008/board/", stream=True) ret = obs.put_object(bucket_name, object_key, input_stream) </pre> （4） put_object_multipart（分片上传） 接口描述 对于大文件上传，可以切分成片上传。在以下情况下，应该考虑使用分片上传： <ul> <li>文件大于 100M</li> <li>网络环境差，上传易导致失败</li> </ul> 需要支持断点续传 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> upload_file_request </td> <td> MutilpartUploadFileRequest </td> <td> true </td> <td> 分片上传参数 upload_file_request的说明： 每个分片（除了最后一个分片）的大小必须不小于 5M，最后一个分片的大小无限制； 若任何一个分片（非最后一个分片）小于 5M，每个分片的上传不会失败，然而分片完成操作（complete）会失败。 enable_checkpoint 用于设置是否启用断点续传。默认启用。通过调用 upload_file_request.set_enable_checkpoint(False) 关闭断点续传功能。 checkpoint_file_path 用于设置断点续传 ucp 文件的保存位置。默认与待上传文件位于同一个目录下面。若非特殊需求，不需要更改此设置。 upload_notifier 用于设置分片上传的通知接收者。可以实现一个 mutilpart_upload_notifier，并调用 upload_file_request.set_upload_notifier 来接收分片上传的进展的通知，以达到如进度感知等目的。 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 实例 <pre> def notify_upload(upload_id, state, total_parts, finish_parts): bucket_name = “YourBucketName” object_key = “YourObjectKey” multipart_upload_file_path = “UploadFilePath” multipart_request = MultipartUploadFileRequest() multipart_request.set_bucket_name(bucket_name) multipart_request.set_object_key(object_key) multipart_request.set_upload_file_path(multipart_upload_file_path) multipart_request.set_upload_notifier(notify_upload) obs.put_object_multipart(multipart_request)</pre> （5） get_object（下载文件） 接口描述 下载指定对象。 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket_name </td> <td> string </td> <td> true </td> <td> 保存对象的 bucket名称 </td> <td> - </td> </tr> <tr> <td> object_key </td> <td> string </td> <td> true </td> <td> 对象 key </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> s3Object </td> <td> S3Object </td> <td> S3Object 返回对象，可以获取对象流自己保存，也可以传入文件对象直接存储 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> bucket_name = “YourBucketName” object_key = “YourObjectKey” to_file_path = “DownloadFilePath” s3_object = obs.get_object(bucket_name, object_key) #读取对象流自己存储 with open(to_file_path, "wb") as to_file:     shutil.copyfileobj(s3_object.get_object_stream(), to_file) #传入文件对象直接存储 with open(to_file_path, "wb") as to_file:     s3_object.to_file(to_file) #获取自定义元数据 print(s3_object.get_object_metadata().get_user_metadata()) </pre>

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