Python SDK接口概览
表1总结了OBS Python SDK支持的接口及功能描述，每个接口的详细介绍和示例代码请前往接口详情页查看。
SDK API概览
接口名 |
方法 |
功能描述 |
|---|---|---|
ObsClient.createBucket |
创建桶。 |
|
ObsClient.listBuckets |
查询桶列表，返回结果按照桶名字典序排列。 |
|
ObsClient.headBucket |
判断桶是否存在。 |
|
ObsClient.deleteBucket |
删除桶，待删除的桶必须为空。 |
|
ObsClient.listObjects |
列举桶内对象，默认返回最大1000个对象。 |
|
ObsClient.listVersions |
列举桶内多版本对象，默认返回最大1000个多版本对象。 |
|
ObsClient.listMultipartUploads |
列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。 |
|
ObsClient.getBucketMetadata |
对桶发送HEAD请求，获取桶的存储类型，CORS规则（如果已设置）等信息。 |
|
ObsClient.getBucketLocation |
获取桶所在的区域位置。 |
|
ObsClient.getBucketStorageInfo |
获取桶的存量信息，包含桶的空间大小以及对象个数。 |
|
ObsClient.setBucketQuota |
设置桶的配值，单位为字节，支持的最大值为263-1，配额值设为0表示桶的配额没有上限。 |
|
ObsClient.getBucketQuota |
获取桶的配额值，0代表配额没有上限。 |
|
ObsClient.setBucketStoragePolicy |
设置桶的存储类型，桶中对象的存储类型默认将与桶的存储类型保持一致。 |
|
ObsClient.getBucketStoragePolicy |
获取桶的存储类型。 |
|
ObsClient.setBucketAcl |
设置桶的访问权限。 |
|
ObsClient.getBucketAcl |
获取桶的访问权限。 |
|
ObsClient.setBucketLogging |
设置桶的访问日志配置。 |
|
ObsClient.getBucketLogging |
获取桶的访问日志配置。 |
|
ObsClient.setBucketPolicy |
配置桶的策略，如果桶已经存在一个策略，那么当前请求中的策略将完全覆盖桶中现存的策略。 |
|
ObsClient.getBucketPolicy |
获取桶的策略配置。 |
|
ObsClient.deleteBucketPolicy |
删除桶的策略配置。 |
|
ObsClient.setBucketLifecycle |
配置桶的生命周期规则，实现定时转换桶中对象的存储类型，以及定时删除桶中对象的功能。 |
|
ObsClient.getBucketLifecycle |
获取桶的生命周期规则。 |
|
ObsClient.deleteBucketLifecycle |
删除桶所有的生命周期规则。 |
|
ObsClient.setBucketWebsite |
设置桶的Website配置。 |
|
ObsClient.getBucketWebsite |
获取桶的Website配置。 |
|
ObsClient.deleteBucketWebsite |
删除指定桶的Website配置。 |
|
ObsClient.setBucketVersioning |
设置桶的多版本状态。 |
|
ObsClient.getBucketVersioning |
获取桶的多版本状态。 |
|
ObsClient.setBucketCors |
设置桶的跨域资源共享规则，以允许客户端浏览器进行跨域请求。 |
|
ObsClient.getBucketCors |
获取指定桶的跨域资源共享规则。 |
|
ObsClient.deleteBucketCors |
删除指定桶的跨域资源共享规则。 |
|
ObsClient.setBucketTagging |
设置桶的标签。 |
|
ObsClient.getBucketTagging |
获取指定桶的标签。 |
|
ObsClient.deleteBucketTagging |
删除指定桶的标签。 |
|
ObsClient.putContent |
上传对象到指定桶中。 |
|
ObsClient.putFile |
上传文件/文件夹到指定桶中。 |
|
ObsClient.appendObject |
对同一个对象追加数据内容。 |
|
ObsClient.getObject |
下载指定桶中的对象。 |
|
ObsClient.copyObject |
为指定桶中的对象创建一个副本。 |
|
ObsClient.deleteObject |
删除指定桶中的对象。 |
|
ObsClient.deleteObjects |
批量删除指定桶中的多个对象。 |
|
ObsClient.getObjectMetadata |
对指定桶中的对象发送HEAD请求，获取对象的元数据信息。 |
|
ObsClient.setObjectMetadata |
对指定桶中的对象的元数据信息。 |
|
ObsClient.setObjectAcl |
设置指定桶中对象的访问权限。 |
|
ObsClient.getObjectAcl |
获取指定桶中对象的访问权限。 |
|
ObsClient.initiateMultipartUpload |
在指定桶中初始化分段上传任务。 |
|
ObsClient.uploadPart |
初始化分段上传任务后，通过分段上传任务的ID，上传段到指定桶中。 |
|
ObsClient.copyPart |
初始化分段上传任务后，通过分段上传任务的ID，复制段到指定桶中。 |
|
ObsClient.listParts |
通过分段上传任务的ID，列举指定桶中已上传的段。 |
|
ObsClient.completeMultipartUpload |
通过分段上传任务的ID，合并指定桶中已上传的段。 |
|
ObsClient.abortMultipartUpload |
通过分段上传任务的ID，取消指定桶中的分段上传任务。 |
|
ObsClient.restoreObject |
恢复指定桶中的归档存储对象。 |
|
ObsClient.createSignedUrl |
通过访问密钥、请求方法类型、请求参数等信息生成一个在Query参数中携带鉴权信息的URL，以对OBS服务进行特定操作。 |
|
ObsClient.createPostSignature |
生成用于鉴权的请求参数，以进行基于浏览器的POST表单上传。 |
|
ObsClient.uploadFile |
对分段上传的封装和加强，解决上传大文件时由于网络不稳定或程序崩溃导致上传失败的问题。 |
|
ObsClient.downloadFile |
对范围下载的封装和加强，解决下载大对象到本地时由于网络不稳定或程序崩溃导致下载失败的问题。 |
|
WorkflowClient.createWorkflow |
根据模板创建工作流。 |
|
WorkflowClient.getWorkflow |
按名称查询工作流。 |
|
WorkflowClient.deleteWorkflow |
删除存在的工作流。 |
|
WorkflowClient.updateWorkflow |
更新工作流。 |
|
WorkflowClient.listWorkflow |
查询工作流列表。 |
|
WorkflowClient.asyncAPIStartWorkflow |
API触发启动工作流。 |
|
WorkflowClient.listWorkflowExecution |
查询工作流实例列表。 |
|
WorkflowClient.getWorkflowExecution |
查询工作流实例详细。 |
|
WorkflowClient.restoreFailedWorkflowExecution |
当且仅当一个工作流实例是执行失败状态才能执行恢复操作。恢复后，工作流实例将从上次失败的状态处继续执行，而已经执行过的状态不会再执行。 |
|
WorkflowClient.putTriggerPolicy |
在桶上绑定工作流触发器。 |
|
WorkflowClient.getTriggerPolicy |
查询桶上绑定工作流触发器。 |
|
WorkflowClient.deleteTriggerPolicy |
删除在桶上绑定工作流触发器。 |
