Harmony SDK接口概览(Harmony SDK)
表1总结了OBS Harmony SDK所有接口的描述与使用方式、方法定义及参数说明等内容。
|
接口名 |
定义方法 |
功能描述 |
|---|---|---|
|
ObsClient.createBucket |
在当前账号按照用户指定的桶名创建一个新桶，接口支持根据用户诉求，在创建桶的同时配置桶的存储类别、区域及桶的访问权限等参数。 |
|
|
ObsClient.listBuckets |
列举当前账号所有地域下符合指定条件的桶。返回结果以桶名的字典序排序。 |
|
|
ObsClient.headBucket |
判断指定桶名的桶是否存在，返回的结果中HTTP状态码为200表明桶存在，否则返回404表明桶不存在。 |
|
|
ObsClient.deleteBucket |
桶为空时，用户可以删除桶，以免占用桶数量配额。删除桶后需要等待30分钟才能创建同名桶。 |
|
|
ObsClient.listObjects |
列举指定桶内的部分或所有对象的描述信息。还可以通过设置前缀、数量、起始位置等参数，返回符合筛选条件的对象信息。返回结果以对象名的字典序排序。 |
|
|
ObsClient.listVersions |
列举指定桶内的部分或所有多版本对象的描述信息。还可以通过设置前缀、数量、起始位置等参数，返回符合您筛选条件的多版本对象信息。返回结果以多版本对象名的字典序排序。 |
|
|
ObsClient.getBucketMetadata |
获取指定桶的相关信息，包括指定桶的存储类别、区域位置、跨域资源共享（CORS）规则、冗余策略等信息。 |
|
|
ObsClient.getBucketLocation |
获取指定桶所在的区域位置。 |
|
|
ObsClient.getBucketStorageInfo |
获取桶的存量信息，包括桶已使用的空间大小以及桶包含的对象个数。 |
|
|
ObsClient.setBucketQuota |
设置桶的配额限制来控制桶内允许上传的对象总容量，超过设置的对象容量后，上传对象会失败。 |
|
|
ObsClient.getBucketQuota |
获取桶的配额值，0代表配额没有上限。 |
|
|
ObsClient.setBucketStoragePolicy |
设置指定桶的存储类别。设置桶的存储类别后，如果上传对象、复制对象和初始化多段上传任务时未指定对象的存储类别，则该对象的存储类别默认与桶的存储类别保持一致。 |
|
|
ObsClient.getBucketStoragePolicy |
获取桶的存储类型。 |
|
|
ObsClient.setBucketAcl |
设置指定桶的ACL策略。 |
|
|
ObsClient.getBucketAcl |
获取指定桶的ACL策略。 |
|
|
ObsClient.setBucketLoggingConfiguration |
为指定桶打开桶日志功能，并配置日志存放的目标桶。桶日志功能开启后，桶的每次操作将会产生一条日志，并将多条日志打包成一个日志文件。日志文件存放到开启日志功能的桶中，也可以存放到其他您有权限的桶中，但需要和开启日志功能的桶在同一个region中。您还可以根据需要配置日志文件的访问权限，以及日志文件的文件名前缀。 |
|
|
ObsClient.getBucketLoggingConfiguration |
获取桶的访问日志配置。 |
|
|
ObsClient.setBucketPolicy |
配置桶的策略，如果桶已经存在一个策略，那么当前请求中的策略将完全覆盖桶中现存的策略。 |
|
|
ObsClient.getBucketPolicy |
获取桶的策略配置。 |
|
|
ObsClient.deleteBucketPolicy |
删除指定桶的桶策略。无论桶的策略本身是否存在，删除成功后系统都直接返回“204 No Content”的结果。 |
|
|
ObsClient.setBucketLifecycleConfiguration |
配置桶的生命周期规则，实现定时转换桶中对象的存储类型，以及定时删除桶中对象的功能。 |
|
|
ObsClient.getBucketLifecycleConfiguration |
获取桶的生命周期规则。 |
|
|
ObsClient.deleteBucketLifecycleConfiguration |
删除桶所有的生命周期规则。 |
|
|
ObsClient.setBucketWebsiteConfiguration |
设置桶的Website配置。 |
|
|
ObsClient.getBucketWebsiteConfiguration |
获取桶的Website配置。 |
|
|
ObsClient.deleteBucketWebsiteConfiguration |
删除指定桶的Website配置。 |
|
|
ObsClient.setBucketVersioning |
为指定桶设置多版本状态。在一个桶中保留对象的多个版本，可方便地检索和还原各个版本，在意外操作或应用程序故障时快速恢复数据。 |
|
|
ObsClient.getBucketVersioning |
获取桶的多版本状态。 |
|
|
ObsClient.setBucketCors |
设置桶的跨域资源共享规则，以允许客户端浏览器进行跨域请求。 |
|
|
ObsClient.getBucketCors |
获取指定桶的跨域资源共享规则。 |
|
|
ObsClient.deleteBucketCors |
删除指定桶的跨域资源共享规则。 |
|
|
ObsClient.setBucketTagging |
为桶添加标签，该桶上所有请求产生的计费话单里都会带上这些标签，从而可以针对话单报表做分类筛选，进行更详细的成本分析。 |
|
|
ObsClient.getBucketTagging |
获取指定桶的标签。 |
|
|
ObsClient.deleteBucketTagging |
删除指定桶的标签。 |
|
|
ObsClient.putObject |
上传对象到指定桶中。 |
|
|
ObsClient.appendObject |
对同一个对象追加数据内容。 |
|
|
ObsClient.getObject |
下载指定桶中的对象。 |
|
|
ObsClient.copyObject |
为指定桶中的对象创建一个副本。在单次操作中，可以创建最大5GB的对象副本。 |
|
|
ObsClient.deleteObject |
根据需要删除指定桶中的对象，节省空间和成本。 |
|
|
ObsClient.deleteObjects |
根据需要批量删除指定桶中的多个对象，节省空间和成本。 批量删除对象用于将一个桶内的部分对象一次性删除，删除后不可恢复。批量删除对象要求返回结果里包含每个对象的删除结果。 |
|
|
ObsClient.getObjectMetadata |
对指定桶中的对象发送HEAD请求，获取对象的元数据信息。 |
|
|
ObsClient.setObjectMetadata |
对指定桶中的对象的元数据信息。 |
|
|
ObsClient.setObjectAcl |
在上传对象时设置权限控制策略，也可以通过ACL操作API接口对已存在的对象更改ACL 。 |
|
|
ObsClient.getObjectAcl |
过接口获取指定桶中对象的ACL访问权限，返回信息包含指定对象的权限控制列表信息。 |
|
|
ObsClient.initiateMultipartUpload |
过接口获取指定桶中对象的ACL访问权限，返回信息包含指定对象的权限控制列表信息。 |
|
|
ObsClient.uploadPart |
初始化分段上传任务后，通过分段上传任务的ID，上传段到指定桶中。 |
|
|
ObsClient.copyPart |
初始化分段上传任务后，通过分段上传任务的ID，复制段到指定桶中。 |
|
|
ObsClient.listParts |
通过分段上传任务的ID，列举指定桶中已上传的段。 |
|
|
ObsClient.listMultipartUploads |
列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。 |
|
|
ObsClient.completeMultipartUpload |
通过分段上传任务的ID和对应已上传的段信息（包括PartNumber和ETag），合并成一个完整的对象。 |
|
|
ObsClient.abortMultipartUpload |
通过分段上传任务的ID，取消指定桶中的分段上传任务。 |
|
|
ObsClient.restoreObject |
如果要下载归档存储对象，需要先将归档存储对象恢复。恢复归档存储对象的恢复选项可支持标准恢复、快速恢复。 |
|
|
ObsClient.createSignedUrl |
通过访问密钥、请求方法类型、请求参数等信息生成一个在Query参数中携带鉴权信息的URL，可将该URL提供给其他用户进行临时访问。在生成URL时，您需要指定URL的有效期来限制访客用户的访问时长。 如果您想授予其他用户对桶或对象临时进行其他操作的权限（例如上传或下载对象），则需要生成带对应请求的URL后（例如使用生成PUT请求的URL上传对象），将该URL提供给其他用户。 |
|
|
ObsClient.createPostSignatureSync |
生成用于鉴权的请求参数，以进行基于浏览器的POST表单上传。 |
