com.aliyun.oss

接口 OSS

所有已知实现类:

OSSClient

public interface OSS

阿里云对象存储服务（Object Storage Service， OSS）的访问接口。

阿里云存储服务（Object Storage Service，简称OSS），是阿里云对外提供的海量，安全，低成本， 高可靠的云存储服务。用户可以通过简单的REST接口，在任何时间、任何地点上传和下载数据， 也可以使用WEB页面对数据进行管理。
基于OSS，用户可以搭建出各种多媒体分享网站、网盘、个人企业数据备份等基于大规模数据的服务。

方法概要

方法

限定符和类型	方法和说明
void	abortMultipartUpload(AbortMultipartUploadRequest request) 终止一个Multipart上传事件。
void	addBucketCname(AddBucketCnameRequest addBucketCnameRequest) 添加Bucket的cname。
void	addBucketReplication(AddBucketReplicationRequest addBucketReplicationRequest) 设置Bucket的跨区域复制规则。
AppendObjectResult	appendObject(AppendObjectRequest appendObjectRequest) 以追加写的方式上传文件或输入流。
String	calculatePostSignature(String postPolicy) 根据Access Key Secret和policy计算签名，OSS依据该签名验证Post请求的合法性。
CompleteMultipartUploadResult	completeMultipartUpload(CompleteMultipartUploadRequest request) 完成一个Multipart上传事件。
CopyObjectResult	copyObject(CopyObjectRequest copyObjectRequest) 拷贝一个在OSS上已经存在的Object成另外一个Object。
CopyObjectResult	copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) 拷贝一个在OSS上已经存在的Object成另外一个Object。
Bucket	createBucket(CreateBucketRequest createBucketRequest) 创建Bucket。
Bucket	createBucket(String bucketName) 创建Bucket。
CreateLiveChannelResult	createLiveChannel(CreateLiveChannelRequest createLiveChannelRequest) 创建Live Channel。
void	createSymlink(CreateSymlinkRequest createSymlinkRequest) 创建符号链接。
void	createSymlink(String bucketName, String symlink, String target)
void	deleteBucket(GenericRequest genericRequest) 删除Bucket。
void	deleteBucket(String bucketName) 删除Bucket。
void	deleteBucketCname(DeleteBucketCnameRequest deleteBucketCnameRequest) 删除Bucket的指定的cname。
void	deleteBucketCname(String bucketName, String domain) 删除Bucket的指定的cname。
void	deleteBucketCORSRules(GenericRequest genericRequest) 删除指定bucket下面的所有跨域访问规则
void	deleteBucketCORSRules(String bucketName) 删除指定bucket下面的所有跨域访问规则
void	deleteBucketImage(String bucketName) 删除Bucket 图片处理功能
void	deleteBucketImage(String bucketName, GenericRequest genericRequest) 删除Bucket 图片处理功能
void	deleteBucketLifecycle(GenericRequest genericRequest) 关闭Bucket的Lifecycle规则。
void	deleteBucketLifecycle(String bucketName) 关闭Bucket的Lifecycle规则。
void	deleteBucketLogging(GenericRequest genericRequest) 关闭Bucket的访问日志记录功能。
void	deleteBucketLogging(String bucketName) 关闭Bucket的访问日志记录功能。
void	deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest) 停止Bucket的跨区域复制并删除复制配置。
void	deleteBucketReplication(String bucketName, String replicationRuleID) 停止Bucket的跨区域复制并删除复制配置。
void	deleteBucketTagging(GenericRequest genericRequest) 删除给定Bucket的标签。
void	deleteBucketTagging(String bucketName) 删除给定Bucket的标签。
void	deleteBucketWebsite(GenericRequest genericRequest) 关闭Bucket的静态网站托管模式。
void	deleteBucketWebsite(String bucketName) 关闭Bucket的静态网站托管模式。
void	deleteImageStyle(String bucketName, String styleName) 删除Bucket 名为styleName 的 style
void	deleteImageStyle(String bucketName, String styleName, GenericRequest genericRequest) 删除Bucket 名为styleName 的 style
void	deleteLiveChannel(LiveChannelGenericRequest liveChannelGenericRequest) 删除Live Channel。
void	deleteLiveChannel(String bucketName, String liveChannel) 删除Live Channel。
void	deleteObject(GenericRequest genericRequest) 删除指定的OSSObject。
void	deleteObject(String bucketName, String key) 删除指定的OSSObject。
DeleteObjectsResult	deleteObjects(DeleteObjectsRequest deleteObjectsRequest) 批量删除指定Bucket下的OSSObject。
boolean	doesBucketExist(GenericRequest genericRequest) 判断给定Bucket是否存在。
boolean	doesBucketExist(String bucketName) 判断给定Bucket是否存在。
boolean	doesObjectExist(HeadObjectRequest headObjectRequest) 判断指定的OSSObject是否存在。
boolean	doesObjectExist(String bucketName, String key) 判断指定Bucket下是否存在指定的OSSObject。
DownloadFileResult	downloadFile(DownloadFileRequest downloadFileRequest) 文件下载 实现原理是将要下载的Object分成若干个分片分别下载，最后所有分片都下 载成功后，完成整个文件的下载。
String	generatePostPolicy(Date expiration, PolicyConditions conds) 生成Post请求的policy表单域。
URL	generatePresignedUrl(GeneratePresignedUrlRequest request) 生成一个包含签名信息并可以访问OSSObject的URL。
URL	generatePresignedUrl(String bucketName, String key, Date expiration) 生成一个用HTTP GET方法访问OSSObject的URL。
URL	generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method) 生成一个用指定HTTP方法访问OSSObject的URL。
String	generateRtmpUri(GenerateRtmpUriRequest generatePushflowUrlRequest) 生成Live Channel的RTMP推流地址。
String	generateRtmpUri(String bucketName, String liveChannelName, String PlaylistName, long expires) 生成Live Channel的RTMP推流地址。
void	generateVodPlaylist(GenerateVodPlaylistRequest generateVodPlaylistRequest) 为指定时间段内的ts文件生成一个点播的播放列表（m3u8文件）。
void	generateVodPlaylist(String bucketName, String liveChannelName, String PlaylistName, long startTime, long endTime) 为指定时间段内的ts文件生成一个点播的播放列表（m3u8文件）。
AccessControlList	getBucketAcl(GenericRequest genericRequest) 返回给定Bucket的Access Control List(ACL)。
AccessControlList	getBucketAcl(String bucketName) 返回给定Bucket的Access Control List(ACL)。
List<CnameConfiguration>	getBucketCname(GenericRequest genericRequest) 获取Bucket已设置的cname。
List<CnameConfiguration>	getBucketCname(String bucketName) 获取Bucket已设置的cname。
List<SetBucketCORSRequest.CORSRule>	getBucketCORSRules(GenericRequest genericRequest) 列出指定bucket的跨域访问规则
List<SetBucketCORSRequest.CORSRule>	getBucketCORSRules(String bucketName) 列出指定bucket的跨域访问规则
GetBucketImageResult	getBucketImage(String bucketName) 获取Bucket 图片处理功能属性
GetBucketImageResult	getBucketImage(String bucketName, GenericRequest genericRequest) 获取Bucket 图片处理功能属性
BucketInfo	getBucketInfo(GenericRequest genericRequest) 获取Bucket的信息。
BucketInfo	getBucketInfo(String bucketName) 获取Bucket的信息。
List<LifecycleRule>	getBucketLifecycle(GenericRequest genericRequest) 获取Bucket的Lifecycle规则列表。
List<LifecycleRule>	getBucketLifecycle(String bucketName) 获取Bucket的Lifecycle规则列表。
String	getBucketLocation(GenericRequest genericRequest) 返回给定Bucket所在的数据中心。
String	getBucketLocation(String bucketName) 返回给定Bucket所在的数据中心。
BucketLoggingResult	getBucketLogging(GenericRequest genericRequest) 查看Bucket的访问日志配置。
BucketLoggingResult	getBucketLogging(String bucketName) 查看Bucket的访问日志配置。
BucketProcess	getBucketProcess(GenericRequest genericRequest) 读取图片处理属性
BucketProcess	getBucketProcess(String bucketName) 读取图片处理属性
BucketReferer	getBucketReferer(GenericRequest genericRequest) 返回给定Bucket的http referer。
BucketReferer	getBucketReferer(String bucketName) 返回给定Bucket的http referer。
List<ReplicationRule>	getBucketReplication(GenericRequest genericRequest) 获取Bucket已设置的跨区域复制规则。
List<ReplicationRule>	getBucketReplication(String bucketName) 获取Bucket已设置的跨区域复制规则。
List<String>	getBucketReplicationLocation(GenericRequest genericRequest) 获取Bucket的所在的数据中心配对的可复制到的数据中心。
List<String>	getBucketReplicationLocation(String bucketName) 获取Bucket所在的数据中心配对的可复制到的数据中心。
BucketReplicationProgress	getBucketReplicationProgress(GetBucketReplicationProgressRequest getBucketReplicationProgressRequest) 获取Bucket的跨区域复制进度。
BucketReplicationProgress	getBucketReplicationProgress(String bucketName, String replicationRuleID) 获取Bucket的跨区域复制进度。
UserQos	getBucketStorageCapacity(GenericRequest genericRequest) 获取Bucket的容量。
UserQos	getBucketStorageCapacity(String bucketName) 获取Bucket的容量。
TagSet	getBucketTagging(GenericRequest genericRequest) 获取给定Bucket的标签。
TagSet	getBucketTagging(String bucketName) 获取给定Bucket的标签。
BucketWebsiteResult	getBucketWebsite(GenericRequest genericRequest) 获取Bucket的静态网站托管状态。
BucketWebsiteResult	getBucketWebsite(String bucketName) 获取Bucket的静态网站托管状态。
GetImageStyleResult	getImageStyle(String bucketName, String styleName) 获取 Bucket 名为styleName 的样式
GetImageStyleResult	getImageStyle(String bucketName, String styleName, GenericRequest genericRequest) 获取 Bucket 名为styleName 的样式
List<LiveRecord>	getLiveChannelHistory(LiveChannelGenericRequest liveChannelGenericRequest) 获取指定Live Channel的推流记录。
List<LiveRecord>	getLiveChannelHistory(String bucketName, String liveChannel) 获取指定Live Channel的推流记录。
LiveChannelInfo	getLiveChannelInfo(LiveChannelGenericRequest liveChannelGenericRequest) 获取Live Channel的配置信息。
LiveChannelInfo	getLiveChannelInfo(String bucketName, String liveChannel) 获取Live Channel的配置信息。
LiveChannelStat	getLiveChannelStat(LiveChannelGenericRequest liveChannelGenericRequest) 获取Live Channel的推流状态。
LiveChannelStat	getLiveChannelStat(String bucketName, String liveChannel) 获取Live Channel的推流状态。
OSSObject	getObject(GetObjectRequest getObjectRequest) 从OSS指定的Bucket中导出OSSObject。
ObjectMetadata	getObject(GetObjectRequest getObjectRequest, File file) 从OSS指定的Bucket中导出指定的OSSObject到目标文件。
OSSObject	getObject(String bucketName, String key) 从OSS指定的Bucket中导出OSSObject。
OSSObject	getObject(URL signedUrl, Map<String,String> requestHeaders) 使用URL签名方式导出OSSObject。
ObjectAcl	getObjectAcl(GenericRequest genericRequest) 返回指定OSSObject的Access Control List(ACL)。
ObjectAcl	getObjectAcl(String bucketName, String key) 返回指定OSSObject的Access Control List(ACL)。
ObjectMetadata	getObjectMetadata(GenericRequest genericRequest) 返回OSSObject的元数据。
ObjectMetadata	getObjectMetadata(String bucketName, String key) 返回OSSObject的元数据。
SimplifiedObjectMeta	getSimplifiedObjectMeta(GenericRequest genericRequest) 获取指定的OSSObject的基本元信息。
SimplifiedObjectMeta	getSimplifiedObjectMeta(String bucketName, String key) 获取指定的OSSObject的基本元信息。
OSSSymlink	getSymlink(GenericRequest genericRequest) 获取符号链接的相关信息。
OSSSymlink	getSymlink(String bucketName, String symlink) 获取符号链接的相关信息。
InitiateMultipartUploadResult	initiateMultipartUpload(InitiateMultipartUploadRequest request) 初始化一个Multipart上传事件。
List<Bucket>	listBuckets() 返回请求者拥有的所有Bucket的列表。
BucketList	listBuckets(ListBucketsRequest listBucketsRequest) 按要求返回请求者的Bucket列表。
BucketList	listBuckets(String prefix, String marker, Integer maxKeys) 按要求返回请求者的Bucket列表。
List<Style>	listImageStyle(String bucketName) 列出 Bucket bucketName下的所有样式
List<Style>	listImageStyle(String bucketName, GenericRequest genericRequest) 列出 Bucket bucketName下的所有样式
LiveChannelListing	listLiveChannels(ListLiveChannelsRequest listLiveChannelRequest) 按照请求参数要求返回的LiveChannel列表。
List<LiveChannel>	listLiveChannels(String bucketName) 列出指定Bucket下的所有LiveChannel的列表。
MultipartUploadListing	listMultipartUploads(ListMultipartUploadsRequest request) 列出所有执行中的 Multipart上传事件。
ObjectListing	listObjects(ListObjectsRequest listObjectsRequest) 列出指定Bucket下的OSSObject。
ObjectListing	listObjects(String bucketName) 列出指定Bucket下的OSSObject。
ObjectListing	listObjects(String bucketName, String prefix) 列出指定Bucket下key以给定prefix开头的OSSObject。
PartListing	listParts(ListPartsRequest request) 列出multipart中上传的所有part信息
ResponseMessage	optionsObject(OptionsRequest request) 已过时。
void	putBucketImage(PutBucketImageRequest request) 开通Bucket 图片处理功能
void	putImageStyle(PutImageStyleRequest putImageStyleRequest) 添加 Bucket 图片处理样式
PutObjectResult	putObject(PutObjectRequest putObjectRequest) 上传指定文件或输入流至指定的Bucket。
PutObjectResult	putObject(String bucketName, String key, File file) 上传指定文件到OSS中指定的Bucket。
PutObjectResult	putObject(String bucketName, String key, File file, ObjectMetadata metadata) 上传指定文件到OSS中指定的Bucket。
PutObjectResult	putObject(String bucketName, String key, InputStream input) 上传指定的OSSObject到OSS中指定的Bucket。
PutObjectResult	putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata) 上传指定的OSSObject到OSS中指定的Bucket。
PutObjectResult	putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders) 使用URL签名方式上传指定输入流。
PutObjectResult	putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders, boolean useChunkEncoding) 使用URL签名方式上传指定输入流。
PutObjectResult	putObject(URL signedUrl, String filePath, Map<String,String> requestHeaders) 使用URL签名方式上传指定文件。
PutObjectResult	putObject(URL signedUrl, String filePath, Map<String,String> requestHeaders, boolean useChunkEncoding) 使用URL签名方式上传指定文件。
void	setBucketAcl(SetBucketAclRequest setBucketAclRequest) 设置指定Bucket的Access Control List(ACL)。
void	setBucketAcl(String bucketName, CannedAccessControlList acl) 设置指定Bucket的Access Control List(ACL)。
void	setBucketCORS(SetBucketCORSRequest request) 操作将在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则
void	setBucketLifecycle(SetBucketLifecycleRequest setBucketLifecycleRequest) 设置Bucket的Lifecycle规则。
void	setBucketLogging(SetBucketLoggingRequest request) 设置Bucket的访问日志记录功能。
void	setBucketProcess(SetBucketProcessRequest setBucketProcessRequest) 创建图片处理属性
void	setBucketReferer(SetBucketRefererRequest setBucketRefererRequest) 设置指定Bucket的http referer。
void	setBucketReferer(String bucketName, BucketReferer referer) 设置指定Bucket的http referer。
void	setBucketStorageCapacity(SetBucketStorageCapacityRequest setBucketStorageCapacityRequest) 设置Bucket的容量。
void	setBucketStorageCapacity(String bucketName, UserQos userQos) 设置Bucket的容量。
void	setBucketTagging(SetBucketTaggingRequest setBucketTaggingRequest) 设置给定Bucket的标签。
void	setBucketTagging(String bucketName, Map<String,String> tags) 设置给定Bucket的标签。
void	setBucketTagging(String bucketName, TagSet tagSet) 设置给定Bucket的标签。
void	setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest) 将一个Bucket设置成静态网站托管模式。
void	setLiveChannelStatus(SetLiveChannelRequest setLiveChannelRequest) 设置Live Channel的状态。
void	setLiveChannelStatus(String bucketName, String liveChannel, LiveChannelStatus status) 设置Live Channel的状态。
void	setObjectAcl(SetObjectAclRequest setObjectAclRequest) 设置指定OSSObject的Access Control List(ACL)。
void	setObjectAcl(String bucketName, String key, CannedAccessControlList cannedAcl) 设置指定OSSObject的Access Control List(ACL)。
void	shutdown() 关闭Client实例，并释放所有正在使用的资源。
void	switchCredentials(Credentials creds) 切换用户身份认证。
UploadFileResult	uploadFile(UploadFileRequest uploadFileRequest) 文件上传 上传的文件分成若干个分片分别上传，最后所有分片都上传 成功后，完成整个文件的上传。
UploadPartResult	uploadPart(UploadPartRequest request) 上传一个分块（Part）到指定的的Multipart上传事件中。
UploadPartCopyResult	uploadPartCopy(UploadPartCopyRequest request) 分片拷贝。

方法详细资料

switchCredentials

void switchCredentials(Credentials creds)

切换用户身份认证。

参数:

creds - 用户身份认证。

shutdown

void shutdown()

关闭Client实例，并释放所有正在使用的资源。 一旦关闭，将不再处理任何发往OSS的请求。

createBucket

Bucket createBucket(String bucketName)
                    throws OSSException,
                           ClientException

创建Bucket。

参数:

bucketName - Bucket名称。

抛出:

OSSException

ClientException

createBucket

Bucket createBucket(CreateBucketRequest createBucketRequest)
                    throws OSSException,
                           ClientException

创建Bucket。

参数:

createBucketRequest - 请求参数CreateBucketRequest。

抛出:

OSSException

ClientException

deleteBucket

void deleteBucket(String bucketName)
                  throws OSSException,
                         ClientException

删除Bucket。

参数:

bucketName - Bucket名称。

抛出:

OSSException

ClientException

deleteBucket

void deleteBucket(GenericRequest genericRequest)
                  throws OSSException,
                         ClientException

删除Bucket。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

listBuckets

List<Bucket> listBuckets()
                         throws OSSException,
                                ClientException

返回请求者拥有的所有Bucket的列表。

返回:

请求者拥有的所有Bucket的列表。

抛出:

OSSException

ClientException

listBuckets

BucketList listBuckets(String prefix,
                     String marker,
                     Integer maxKeys)
                       throws OSSException,
                              ClientException

按要求返回请求者的Bucket列表。

参数:

prefix - 限定返回的bucket的名字必须以prefix作为前缀，可以为null（表示不设置前缀）

marker - 设定结果从marker之后按字母排序的第一个开始返回，可以为null（表示没有marker的点，从头开始返回）

maxKeys - 限定此次返回bucket的最大数，取值不能大于1000，默认为100，可以为null（表示默认返回最多100个）

返回:

该次请求获得的所有Bucket的列表。

抛出:

OSSException

ClientException

listBuckets

BucketList listBuckets(ListBucketsRequest listBucketsRequest)
                       throws OSSException,
                              ClientException

按要求返回请求者的Bucket列表。

参数:

listBucketsRequest - 请求信息

返回:

该次请求获得的所有Bucket的列表。

抛出:

OSSException

ClientException

setBucketAcl

void setBucketAcl(String bucketName,
                CannedAccessControlList acl)
                  throws OSSException,
                         ClientException

设置指定Bucket的Access Control List(ACL)。

参数:

bucketName - Bucket名称。

acl - CannedAccessControlList中列出的ACL。 如果传入null，则保持Bucket原先的ACL不变。

抛出:

OSSException

ClientException

setBucketAcl

void setBucketAcl(SetBucketAclRequest setBucketAclRequest)
                  throws OSSException,
                         ClientException

设置指定Bucket的Access Control List(ACL)。

参数:

bucketName - Bucket名称。

setBucketAclRequest - 请求信息。

抛出:

OSSException

ClientException

getBucketAcl

AccessControlList getBucketAcl(String bucketName)
                               throws OSSException,
                                      ClientException

返回给定Bucket的Access Control List(ACL)。

参数:

bucketName - Bucket名称。

返回:

Access Control List(ACL) AccessControlList。

抛出:

OSSException

ClientException

getBucketAcl

AccessControlList getBucketAcl(GenericRequest genericRequest)
                               throws OSSException,
                                      ClientException

返回给定Bucket的Access Control List(ACL)。

参数:

genericRequest - 请求信息。

返回:

Access Control List(ACL) AccessControlList。

抛出:

OSSException

ClientException

setBucketReferer

void setBucketReferer(String bucketName,
                    BucketReferer referer)
                      throws OSSException,
                             ClientException

设置指定Bucket的http referer。

参数:

bucketName - Bucket名称。

referer - BucketReferer。 如果传入null，则表示使用默认值BucketReferer。

抛出:

OSSException

ClientException

setBucketReferer

void setBucketReferer(SetBucketRefererRequest setBucketRefererRequest)
                      throws OSSException,
                             ClientException

设置指定Bucket的http referer。

参数:

bucketName - Bucket名称。

setBucketRefererRequest - 请求信息。

抛出:

OSSException

ClientException

getBucketReferer

BucketReferer getBucketReferer(String bucketName)
                               throws OSSException,
                                      ClientException

返回给定Bucket的http referer。

参数:

bucketName - Bucket名称。

返回:

bucket http referer BucketReferer。

抛出:

OSSException

ClientException

getBucketReferer

BucketReferer getBucketReferer(GenericRequest genericRequest)
                               throws OSSException,
                                      ClientException

返回给定Bucket的http referer。

参数:

genericRequest - 请求信息。

返回:

bucket http referer BucketReferer。

抛出:

OSSException

ClientException

getBucketLocation

String getBucketLocation(String bucketName)
                         throws OSSException,
                                ClientException

返回给定Bucket所在的数据中心。

参数:

bucketName - Bucket名称。

返回:

Bucket所在的数据中心。

抛出:

OSSException

ClientException

getBucketLocation

String getBucketLocation(GenericRequest genericRequest)
                         throws OSSException,
                                ClientException

返回给定Bucket所在的数据中心。

参数:

genericRequest - 请求信息。

返回:

Bucket所在的数据中心。

抛出:

OSSException

ClientException

setBucketTagging

void setBucketTagging(String bucketName,
                    Map<String,String> tags)
                      throws OSSException,
                             ClientException

设置给定Bucket的标签。

参数:

bucketName - Bucket名称。

tags - 标签集。

抛出:

OSSException

ClientException

setBucketTagging

void setBucketTagging(String bucketName,
                    TagSet tagSet)
                      throws OSSException,
                             ClientException

设置给定Bucket的标签。

参数:

bucketName - Bucket名称。

tagSet - 标签集。

抛出:

OSSException

ClientException

setBucketTagging

void setBucketTagging(SetBucketTaggingRequest setBucketTaggingRequest)
                      throws OSSException,
                             ClientException

设置给定Bucket的标签。

参数:

setBucketTaggingRequest - 请求信息。

抛出:

OSSException

ClientException

getBucketTagging

TagSet getBucketTagging(String bucketName)
                        throws OSSException,
                               ClientException

获取给定Bucket的标签。

参数:

bucketName - Bucket名称。

返回:

Bucket标签。

抛出:

OSSException

ClientException

getBucketTagging

TagSet getBucketTagging(GenericRequest genericRequest)
                        throws OSSException,
                               ClientException

获取给定Bucket的标签。

参数:

genericRequest - 请求信息。

返回:

Bucket标签。

抛出:

OSSException

ClientException

deleteBucketTagging

void deleteBucketTagging(String bucketName)
                         throws OSSException,
                                ClientException

删除给定Bucket的标签。

参数:

bucketName - Bucket名称。

抛出:

OSSException

ClientException

deleteBucketTagging

void deleteBucketTagging(GenericRequest genericRequest)
                         throws OSSException,
                                ClientException

删除给定Bucket的标签。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

doesBucketExist

boolean doesBucketExist(String bucketName)
                        throws OSSException,
                               ClientException

判断给定Bucket是否存在。

参数:

bucketName - Bucket名称。

抛出:

OSSException

ClientException

doesBucketExist

boolean doesBucketExist(GenericRequest genericRequest)
                        throws OSSException,
                               ClientException

判断给定Bucket是否存在。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

listObjects

ObjectListing listObjects(String bucketName)
                          throws OSSException,
                                 ClientException

列出指定Bucket下的OSSObject。

参数:

bucketName - Bucket名称。

返回:

Object列表ObjectListing

抛出:

OSSException

ClientException

listObjects

ObjectListing listObjects(String bucketName,
                        String prefix)
                          throws OSSException,
                                 ClientException

列出指定Bucket下key以给定prefix开头的OSSObject。

参数:

bucketName - Bucket名称。

prefix - 限定返回的Object key必须以prefix作为前缀。

返回:

Object列表ObjectListing

抛出:

OSSException

ClientException

listObjects

ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
                          throws OSSException,
                                 ClientException

列出指定Bucket下的OSSObject。

参数:

listObjectsRequest - 请求信息。

返回:

object列表ObjectListing

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(String bucketName,
                        String key,
                        InputStream input)
                          throws OSSException,
                                 ClientException

上传指定的OSSObject到OSS中指定的Bucket。

参数:

bucketName - Bucket名称。

key - object的key。

input - 输入流。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(String bucketName,
                        String key,
                        InputStream input,
                        ObjectMetadata metadata)
                          throws OSSException,
                                 ClientException

上传指定的OSSObject到OSS中指定的Bucket。

参数:

bucketName - Bucket名称。

key - object的key。

input - 输入流。

metadata - object的元信息ObjectMetadata，若该元信息未包含Content-Length， 则采用chunked编码传输请求数据。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(String bucketName,
                        String key,
                        File file,
                        ObjectMetadata metadata)
                          throws OSSException,
                                 ClientException

上传指定文件到OSS中指定的Bucket。

参数:

bucketName - Bucket名称。

key - object的key。

file - 指定上传文件。

metadata - object的元信息ObjectMetadata，若该元信息未包含Content-Length， 则采用chunked编码传输请求数据。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(String bucketName,
                        String key,
                        File file)
                          throws OSSException,
                                 ClientException

上传指定文件到OSS中指定的Bucket。

参数:

bucketName - Bucket名称。

key - object的key。

file - 指定上传文件。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(PutObjectRequest putObjectRequest)
                          throws OSSException,
                                 ClientException

上传指定文件或输入流至指定的Bucket。

参数:

putObjectRequest - 请求参数PutObjectRequest。

返回:

请求结果PutObjectResult实例。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(URL signedUrl,
                        String filePath,
                        Map<String,String> requestHeaders)
                          throws OSSException,
                                 ClientException

使用URL签名方式上传指定文件。

参数:

signedUrl - PUT请求类型的URL签名。

filePath - 上传文件的路径。

requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。

返回:

请求结果PutObjectResult实例。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(URL signedUrl,
                        String filePath,
                        Map<String,String> requestHeaders,
                        boolean useChunkEncoding)
                          throws OSSException,
                                 ClientException

使用URL签名方式上传指定文件。

参数:

signedUrl - PUT请求类型的URL签名。

filePath - 上传文件的路径。

requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。

useChunkEncoding - 是否采用chunked编码传输请求数据。

返回:

请求结果PutObjectResult实例。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(URL signedUrl,
                        InputStream requestContent,
                        long contentLength,
                        Map<String,String> requestHeaders)
                          throws OSSException,
                                 ClientException

使用URL签名方式上传指定输入流。

参数:

signedUrl - PUT请求类型的URL签名。

requestContent - 请求输入流。

contentLength - 请求输入流的长度。

requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。

返回:

请求结果PutObjectResult实例。

抛出:

OSSException

ClientException

putObject

PutObjectResult putObject(URL signedUrl,
                        InputStream requestContent,
                        long contentLength,
                        Map<String,String> requestHeaders,
                        boolean useChunkEncoding)
                          throws OSSException,
                                 ClientException

使用URL签名方式上传指定输入流。

参数:

signedUrl - PUT请求类型的URL签名。

requestContent - 请求输入流。

contentLength - 请求输入流的长度，如果采用chunked编码则设置为-1。

requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。

useChunkEncoding - 是否采用chunked编码传输请求数据。

返回:

请求结果PutObjectResult实例。

抛出:

OSSException

ClientException

copyObject

CopyObjectResult copyObject(String sourceBucketName,
                          String sourceKey,
                          String destinationBucketName,
                          String destinationKey)
                            throws OSSException,
                                   ClientException

拷贝一个在OSS上已经存在的Object成另外一个Object。

参数:

sourceBucketName - 源Object所在的Bucket的名称。

sourceKey - 源Object的Key。

destinationBucketName - 目标Object所在的Bucket的名称。

destinationKey - 目标Object的Key。

返回:

请求结果CopyObjectResult实例。

抛出:

OSSException

ClientException

copyObject

CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
                            throws OSSException,
                                   ClientException

拷贝一个在OSS上已经存在的Object成另外一个Object。

参数:

copyObjectRequest - 请求参数CopyObjectRequest实例。

返回:

抛出:

OSSException

ClientException

getObject

OSSObject getObject(String bucketName,
                  String key)
                    throws OSSException,
                           ClientException

从OSS指定的Bucket中导出OSSObject。

参数:

bucketName - Bucket名称。

key - Object Key。

返回:

请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。

抛出:

OSSException

ClientException

getObject

ObjectMetadata getObject(GetObjectRequest getObjectRequest,
                       File file)
                         throws OSSException,
                                ClientException

从OSS指定的Bucket中导出指定的OSSObject到目标文件。

参数:

getObjectRequest - 请求参数GetObjectRequest。

file - 目标文件。

抛出:

OSSException

ClientException

getObject

OSSObject getObject(GetObjectRequest getObjectRequest)
                    throws OSSException,
                           ClientException

从OSS指定的Bucket中导出OSSObject。

参数:

getObjectRequest - 请求参数GetObjectRequest。

返回:

请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。

抛出:

OSSException

ClientException

getObject

OSSObject getObject(URL signedUrl,
                  Map<String,String> requestHeaders)
                    throws OSSException,
                           ClientException

使用URL签名方式导出OSSObject。

参数:

signedUrl - GET请求类型的URL签名。

requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。

返回:

请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。

抛出:

OSSException

ClientException

getSimplifiedObjectMeta

SimplifiedObjectMeta getSimplifiedObjectMeta(String bucketName,
                                           String key)
                                             throws OSSException,
                                                    ClientException

获取指定的OSSObject的基本元信息。

相比Head Object更轻量，仅返回指定Object的少量基本meta信息， 包括该Object的ETag、Size（文件大小）、LastModified（最后修改时间）。

参数:

bucketName - Bucket名称。

key - Object key。

返回:

指定OSSObject的基本元信息SimplifiedObjectMeta。

抛出:

OSSException

ClientException

getSimplifiedObjectMeta

SimplifiedObjectMeta getSimplifiedObjectMeta(GenericRequest genericRequest)
                                             throws OSSException,
                                                    ClientException

获取指定的OSSObject的基本元信息。

相比Head Object更轻量，仅返回指定Object的少量基本meta信息， 包括该Object的ETag、Size（文件大小）、LastModified（最后修改时间）。

参数:

genericRequest - 请求信息。

返回:

指定OSSObject的基本元信息SimplifiedObjectMeta。

抛出:

OSSException

ClientException

getObjectMetadata

ObjectMetadata getObjectMetadata(String bucketName,
                               String key)
                                 throws OSSException,
                                        ClientException

返回OSSObject的元数据。

参数:

bucketName - Bucket名称。

key - Object key。

抛出:

OSSException

ClientException

getObjectMetadata

ObjectMetadata getObjectMetadata(GenericRequest genericRequest)
                                 throws OSSException,
                                        ClientException

返回OSSObject的元数据。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

appendObject

AppendObjectResult appendObject(AppendObjectRequest appendObjectRequest)
                                throws OSSException,
                                       ClientException

以追加写的方式上传文件或输入流。

参数:

appendObjectRequest - 请求参数AppendObjectRequest实例。

返回:

追加写的结果。

抛出:

OSSException

ClientException

deleteObject

void deleteObject(String bucketName,
                String key)
                  throws OSSException,
                         ClientException

删除指定的OSSObject。

参数:

bucketName - Bucket名称。

key - Object key。

抛出:

OSSException

ClientException

deleteObject

void deleteObject(GenericRequest genericRequest)
                  throws OSSException,
                         ClientException

删除指定的OSSObject。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

deleteObjects

DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
                                  throws OSSException,
                                         ClientException

批量删除指定Bucket下的OSSObject。

参数:

deleteObjectsRequest - 请求参数DeleteObjectsRequest实例。

返回:

批量删除结果。

抛出:

OSSException

ClientException

doesObjectExist

boolean doesObjectExist(String bucketName,
                      String key)
                        throws OSSException,
                               ClientException

判断指定Bucket下是否存在指定的OSSObject。

参数:

bucketName - Bucket名称。

key - Object Key。

返回:

如果存在返回True，不存在则返回False。

抛出:

OSSException

ClientException

doesObjectExist

boolean doesObjectExist(HeadObjectRequest headObjectRequest)
                        throws OSSException,
                               ClientException

判断指定的OSSObject是否存在。

参数:

headObjectRequest - 请求参数HeadObjectRequest实例。

返回:

如果存在返回True，不存在则返回False。

抛出:

OSSException

ClientException

setObjectAcl

void setObjectAcl(String bucketName,
                String key,
                CannedAccessControlList cannedAcl)
                  throws OSSException,
                         ClientException

设置指定OSSObject的Access Control List(ACL)。

参数:

bucketName - Bucket名称。

key - Object Key。

cannedAcl - Private/PublicRead/PublicReadWrite中的一种。

抛出:

OSSException

ClientException

setObjectAcl

void setObjectAcl(SetObjectAclRequest setObjectAclRequest)
                  throws OSSException,
                         ClientException

设置指定OSSObject的Access Control List(ACL)。

参数:

setObjectAclRequest - 请求信息。

抛出:

OSSException

ClientException

getObjectAcl

ObjectAcl getObjectAcl(String bucketName,
                     String key)
                       throws OSSException,
                              ClientException

返回指定OSSObject的Access Control List(ACL)。

参数:

bucketName - Bucket名称。

key - Object Key。

返回:

指定OSSObject的Access Control List(ACL)。

抛出:

OSSException

ClientException

getObjectAcl

ObjectAcl getObjectAcl(GenericRequest genericRequest)
                       throws OSSException,
                              ClientException

返回指定OSSObject的Access Control List(ACL)。

参数:

bucketName - Bucket名称。

genericRequest - 请求信息。

抛出:

OSSException

ClientException

generatePresignedUrl

URL generatePresignedUrl(String bucketName,
                       String key,
                       Date expiration)
                         throws ClientException

生成一个用HTTP GET方法访问OSSObject的URL。

参数:

bucketName - Bucket名称。

key - Object key。

expiration - URL的超时时间。

返回:

访问OSSObject的URL。

抛出:

ClientException

generatePresignedUrl

URL generatePresignedUrl(String bucketName,
                       String key,
                       Date expiration,
                       HttpMethod method)
                         throws ClientException

生成一个用指定HTTP方法访问OSSObject的URL。

参数:

bucketName - Bucket名称。

key - Object Key。

expiration - URL的超时时间。

method - HTTP方法，只支持HttpMethod.GET和HttpMethod.PUT。

返回:

访问OSSObject的URL。

抛出:

ClientException

generatePresignedUrl

URL generatePresignedUrl(GeneratePresignedUrlRequest request)
                         throws ClientException

生成一个包含签名信息并可以访问OSSObject的URL。

参数:

request - GeneratePresignedUrlRequest对象。

返回:

包含签名信息并可以访问OSSObject的URL。

抛出:

ClientException

putBucketImage

void putBucketImage(PutBucketImageRequest request)
                    throws OSSException,
                           ClientException

开通Bucket 图片处理功能

参数:

request -

抛出:

OSSException

ClientException

getBucketImage

GetBucketImageResult getBucketImage(String bucketName)
                                    throws OSSException,
                                           ClientException

获取Bucket 图片处理功能属性

参数:

result -

抛出:

OSSException

ClientException

getBucketImage

GetBucketImageResult getBucketImage(String bucketName,
                                  GenericRequest genericRequest)
                                    throws OSSException,
                                           ClientException

获取Bucket 图片处理功能属性

参数:

result -

genericRequest -

抛出:

OSSException

ClientException

deleteBucketImage

void deleteBucketImage(String bucketName)
                       throws OSSException,
                              ClientException

删除Bucket 图片处理功能

抛出:

OSSException

ClientException

deleteBucketImage

void deleteBucketImage(String bucketName,
                     GenericRequest genericRequest)
                       throws OSSException,
                              ClientException

删除Bucket 图片处理功能

参数:

genericRequest -

抛出:

OSSException

ClientException

deleteImageStyle

void deleteImageStyle(String bucketName,
                    String styleName)
                      throws OSSException,
                             ClientException

删除Bucket 名为styleName 的 style

参数:

bucketName -

styleName -

抛出:

OSSException

ClientException

deleteImageStyle

void deleteImageStyle(String bucketName,
                    String styleName,
                    GenericRequest genericRequest)
                      throws OSSException,
                             ClientException

删除Bucket 名为styleName 的 style

参数:

bucketName -

styleName -

genericRequest -

抛出:

OSSException

ClientException

putImageStyle

void putImageStyle(PutImageStyleRequest putImageStyleRequest)
                   throws OSSException,
                          ClientException

添加 Bucket 图片处理样式

参数:

putImageStyleRequest -

抛出:

OSSException

ClientException

getImageStyle

GetImageStyleResult getImageStyle(String bucketName,
                                String styleName)
                                  throws OSSException,
                                         ClientException

获取 Bucket 名为styleName 的样式

参数:

bucketName -

styleName -

抛出:

OSSException

ClientException

getImageStyle

GetImageStyleResult getImageStyle(String bucketName,
                                String styleName,
                                GenericRequest genericRequest)
                                  throws OSSException,
                                         ClientException

获取 Bucket 名为styleName 的样式

参数:

bucketName -

styleName -

genericRequest -

抛出:

OSSException

ClientException

listImageStyle

List<Style> listImageStyle(String bucketName)
                           throws OSSException,
                                  ClientException

列出 Bucket bucketName下的所有样式

参数:

bucketName -

genericRequest -

抛出:

OSSException

ClientException

listImageStyle

List<Style> listImageStyle(String bucketName,
                         GenericRequest genericRequest)
                           throws OSSException,
                                  ClientException

列出 Bucket bucketName下的所有样式

参数:

bucketName -

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

setBucketProcess

void setBucketProcess(SetBucketProcessRequest setBucketProcessRequest)
                      throws OSSException,
                             ClientException

创建图片处理属性

参数:

setBucketProcessRequest - 请求信息。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketProcess

BucketProcess getBucketProcess(String bucketName)
                               throws OSSException,
                                      ClientException

读取图片处理属性

参数:

bucketName - Bucket名称。

返回:

图片处理属性

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketProcess

BucketProcess getBucketProcess(GenericRequest genericRequest)
                               throws OSSException,
                                      ClientException

读取图片处理属性

参数:

genericRequest - 请求信息。

返回:

图片处理属性

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

initiateMultipartUpload

InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException

初始化一个Multipart上传事件。

使用Multipart模式上传数据前，必须先调用该接口来通过OSS初始化一个Multipart上传事件。 该接口会返回一个OSS服务器创建的全局唯一的Upload ID，用于标识本次Multipart上传事件。 用户可以根据这个ID来发起相关的操作，如中止、查询Multipart上传等。

此方法对应的操作为非幂等操作，SDK不会对其进行重试（即使设置最大重试次数大于0也不会重试）

参数:

request - InitiateMultipartUploadRequest对象。

返回:

InitiateMultipartUploadResult

抛出:

ClientException

OSSException

listMultipartUploads

MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                            throws OSSException,
                                                   ClientException

列出所有执行中的 Multipart上传事件。

即已经被初始化的 Multipart Upload 但是未被完成或被终止的 Multipart上传事件。 OSS返回的罗列结果中最多会包含1000个Multipart上传事件。

参数:

request - ListMultipartUploadsRequest对象。

返回:

MultipartUploadListing Multipart上传事件的列表MultipartUploadListing。

抛出:

ClientException

OSSException

listParts

PartListing listParts(ListPartsRequest request)
                      throws OSSException,
                             ClientException

列出multipart中上传的所有part信息

参数:

request - ListPartsRequest对象。

返回:

PartListing

抛出:

ClientException

OSSException

uploadPart

UploadPartResult uploadPart(UploadPartRequest request)
                            throws OSSException,
                                   ClientException

上传一个分块（Part）到指定的的Multipart上传事件中。

参数:

request - UploadPartRequest对象。

返回:

UploadPartResult 上传Part的返回结果UploadPartResult。

抛出:

ClientException

OSSException

uploadPartCopy

UploadPartCopyResult uploadPartCopy(UploadPartCopyRequest request)
                                    throws OSSException,
                                           ClientException

分片拷贝。

参数:

request - 分片拷贝请求参数。

返回:

分片拷贝结果。

抛出:

OSSException

ClientException

abortMultipartUpload

void abortMultipartUpload(AbortMultipartUploadRequest request)
                          throws OSSException,
                                 ClientException

终止一个Multipart上传事件。

参数:

request - AbortMultipartUploadRequest对象。

抛出:

ClientException

OSSException

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException

完成一个Multipart上传事件。

在将所有数据Part 都上传完成后，可以调用 Complete Multipart Upload API 来完成整个文件的 Multipart Upload。在执行该操作时，用户必须提供所有有效 的数据Part的列表（包括part号码和ETAG）； OSS收到用户提交的Part列表后， 会逐一验证每个数据 Part 的有效性。当所有的数据 Part 验证通过后，OSS 将把 这些数据part组合成一个完整的 Object。

此方法对应的操作为非幂等操作，SDK不会对其进行重试（即使设置最大重试次数大于0也不会重试）

参数:

request - CompleteMultipartUploadRequest对象。

返回:

CompleteMultipartUploadResult

抛出:

ClientException

OSSException

setBucketCORS

void setBucketCORS(SetBucketCORSRequest request)
                   throws OSSException,
                          ClientException

操作将在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则

参数:

request - SetBucketCORSRequest}

抛出:

OSSException

ClientException

getBucketCORSRules

List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(String bucketName)
                                                       throws OSSException,
                                                              ClientException

列出指定bucket的跨域访问规则

参数:

bucketName -

返回:

抛出:

OSSException

ClientException

getBucketCORSRules

List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(GenericRequest genericRequest)
                                                       throws OSSException,
                                                              ClientException

列出指定bucket的跨域访问规则

参数:

genericRequest - 请求信息。

返回:

抛出:

OSSException

ClientException

deleteBucketCORSRules

void deleteBucketCORSRules(String bucketName)
                           throws OSSException,
                                  ClientException

删除指定bucket下面的所有跨域访问规则

参数:

bucketName -

抛出:

OSSException

ClientException

deleteBucketCORSRules

void deleteBucketCORSRules(GenericRequest genericRequest)
                           throws OSSException,
                                  ClientException

删除指定bucket下面的所有跨域访问规则

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

optionsObject

@Deprecated
ResponseMessage optionsObject(OptionsRequest request)
                              throws OSSException,
                                     ClientException

已过时。

该接口已过时。

抛出:

OSSException

ClientException

setBucketLogging

void setBucketLogging(SetBucketLoggingRequest request)
                      throws OSSException,
                             ClientException

设置Bucket的访问日志记录功能。 这个功能开启后，OSS将自动记录访问这个Bucket请求的详细信息，并按照用户指定的规则， 以小时为单位，将访问日志作为一个Object写入用户指定的Bucket。

参数:

request - PutBucketLoggingRequest对象。

抛出:

OSSException

ClientException

getBucketLogging

BucketLoggingResult getBucketLogging(String bucketName)
                                     throws OSSException,
                                            ClientException

查看Bucket的访问日志配置。

参数:

bucketName -

返回:

抛出:

OSSException

ClientException

getBucketLogging

BucketLoggingResult getBucketLogging(GenericRequest genericRequest)
                                     throws OSSException,
                                            ClientException

查看Bucket的访问日志配置。

参数:

genericRequest - 请求信息。

返回:

抛出:

OSSException

ClientException

deleteBucketLogging

void deleteBucketLogging(String bucketName)
                         throws OSSException,
                                ClientException

关闭Bucket的访问日志记录功能。

参数:

bucketName -

抛出:

OSSException

ClientException

deleteBucketLogging

void deleteBucketLogging(GenericRequest genericRequest)
                         throws OSSException,
                                ClientException

关闭Bucket的访问日志记录功能。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

setBucketWebsite

void setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest)
                      throws OSSException,
                             ClientException

将一个Bucket设置成静态网站托管模式。

参数:

setBucketWebSiteRequest -

抛出:

OSSException

ClientException

getBucketWebsite

BucketWebsiteResult getBucketWebsite(String bucketName)
                                     throws OSSException,
                                            ClientException

获取Bucket的静态网站托管状态。

参数:

bucketName -

返回:

抛出:

OSSException

ClientException

getBucketWebsite

BucketWebsiteResult getBucketWebsite(GenericRequest genericRequest)
                                     throws OSSException,
                                            ClientException

获取Bucket的静态网站托管状态。

参数:

genericRequest - 请求信息。

返回:

抛出:

OSSException

ClientException

deleteBucketWebsite

void deleteBucketWebsite(String bucketName)
                         throws OSSException,
                                ClientException

关闭Bucket的静态网站托管模式。

参数:

bucketName -

抛出:

OSSException

ClientException

deleteBucketWebsite

void deleteBucketWebsite(GenericRequest genericRequest)
                         throws OSSException,
                                ClientException

关闭Bucket的静态网站托管模式。

参数:

genericRequest - 请求信息。

抛出:

OSSException

ClientException

generatePostPolicy

String generatePostPolicy(Date expiration,
                        PolicyConditions conds)
                          throws ClientException

生成Post请求的policy表单域。

参数:

expiration - policy过期时间。

conds - policy条件列表。

返回:

policy字符串。

抛出:

ClientException

calculatePostSignature

String calculatePostSignature(String postPolicy)

根据Access Key Secret和policy计算签名，OSS依据该签名验证Post请求的合法性。

参数:

postPolicy - 由generatePostPolicy(Date, PolicyConditions)生成的policy字符串。

返回:

post签名。

setBucketLifecycle

void setBucketLifecycle(SetBucketLifecycleRequest setBucketLifecycleRequest)
                        throws OSSException,
                               ClientException

设置Bucket的Lifecycle规则。

参数:

setBucketLifecycleRequest - 请求参数。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketLifecycle

List<LifecycleRule> getBucketLifecycle(String bucketName)
                                       throws OSSException,
                                              ClientException

获取Bucket的Lifecycle规则列表。

参数:

bucketName - 指定Bucket名称。

返回:

Lifecycle规则列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketLifecycle

List<LifecycleRule> getBucketLifecycle(GenericRequest genericRequest)
                                       throws OSSException,
                                              ClientException

获取Bucket的Lifecycle规则列表。

参数:

genericRequest - 请求信息。

返回:

Lifecycle规则列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteBucketLifecycle

void deleteBucketLifecycle(String bucketName)
                           throws OSSException,
                                  ClientException

关闭Bucket的Lifecycle规则。

参数:

bucketName - 指定Bucket名称。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteBucketLifecycle

void deleteBucketLifecycle(GenericRequest genericRequest)
                           throws OSSException,
                                  ClientException

关闭Bucket的Lifecycle规则。

参数:

genericRequest - 请求信息。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

addBucketReplication

void addBucketReplication(AddBucketReplicationRequest addBucketReplicationRequest)
                          throws OSSException,
                                 ClientException

设置Bucket的跨区域复制规则。

参数:

addBucketReplicationRequest - 请求参数。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketReplication

List<ReplicationRule> getBucketReplication(String bucketName)
                                           throws OSSException,
                                                  ClientException

获取Bucket已设置的跨区域复制规则。

参数:

bucketName - 指定Bucket名称。

返回:

已设置的跨区域复制规则列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketReplication

List<ReplicationRule> getBucketReplication(GenericRequest genericRequest)
                                           throws OSSException,
                                                  ClientException

获取Bucket已设置的跨区域复制规则。

参数:

genericRequest - 请求信息。

返回:

已设置的跨区域复制规则列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteBucketReplication

void deleteBucketReplication(String bucketName,
                           String replicationRuleID)
                             throws OSSException,
                                    ClientException

停止Bucket的跨区域复制并删除复制配置。

参数:

bucketName - 指定Bucket名称。

replicationRuleID - 复制规则对应的ID。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteBucketReplication

void deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
                             throws OSSException,
                                    ClientException

停止Bucket的跨区域复制并删除复制配置。

参数:

deleteBucketReplicationRequest - 请求信息。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketReplicationProgress

BucketReplicationProgress getBucketReplicationProgress(String bucketName,
                                                     String replicationRuleID)
                                                       throws OSSException,
                                                              ClientException

获取Bucket的跨区域复制进度。

参数:

bucketName - 指定Bucket名称。

replicationRuleID - 复制规则对应的ID。

返回:

历史数据和新写入数据的复制进度。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketReplicationProgress

BucketReplicationProgress getBucketReplicationProgress(GetBucketReplicationProgressRequest getBucketReplicationProgressRequest)
                                                       throws OSSException,
                                                              ClientException

获取Bucket的跨区域复制进度。

参数:

genericRequest - 请求信息。

返回:

历史数据和新写入数据的复制进度。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketReplicationLocation

List<String> getBucketReplicationLocation(String bucketName)
                                          throws OSSException,
                                                 ClientException

获取Bucket所在的数据中心配对的可复制到的数据中心。

参数:

bucketName - 指定Bucket名称。

返回:

可复制到的数据中心列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketReplicationLocation

List<String> getBucketReplicationLocation(GenericRequest genericRequest)
                                          throws OSSException,
                                                 ClientException

获取Bucket的所在的数据中心配对的可复制到的数据中心。

参数:

genericRequest - 请求信息。

返回:

可复制到的数据中心列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

addBucketCname

void addBucketCname(AddBucketCnameRequest addBucketCnameRequest)
                    throws OSSException,
                           ClientException

添加Bucket的cname。

参数:

setBucketCnameRequest - 请求参数。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketCname

List<CnameConfiguration> getBucketCname(String bucketName)
                                        throws OSSException,
                                               ClientException

获取Bucket已设置的cname。

参数:

bucketName - 指定Bucket名称。

返回:

已设置的跨区域复制规则列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketCname

List<CnameConfiguration> getBucketCname(GenericRequest genericRequest)
                                        throws OSSException,
                                               ClientException

获取Bucket已设置的cname。

参数:

genericRequest - 请求信息。

返回:

已设置的跨区域复制规则列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteBucketCname

void deleteBucketCname(String bucketName,
                     String domain)
                       throws OSSException,
                              ClientException

删除Bucket的指定的cname。

参数:

bucketName - 指定Bucket名称。

domain - cname。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteBucketCname

void deleteBucketCname(DeleteBucketCnameRequest deleteBucketCnameRequest)
                       throws OSSException,
                              ClientException

删除Bucket的指定的cname。

参数:

deleteBucketCnameRequest - 删除cname请求。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketInfo

BucketInfo getBucketInfo(String bucketName)
                         throws OSSException,
                                ClientException

获取Bucket的信息。

参数:

bucketName - 指定Bucket名称。

返回:

Bucket信息。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketInfo

BucketInfo getBucketInfo(GenericRequest genericRequest)
                         throws OSSException,
                                ClientException

获取Bucket的信息。

参数:

genericRequest - 请求信息。

返回:

Bucket信息。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

setBucketStorageCapacity

void setBucketStorageCapacity(String bucketName,
                            UserQos userQos)
                              throws OSSException,
                                     ClientException

设置Bucket的容量。

参数:

bucketName - 指定Bucket名称。

userQos - 包括的容量的Bucket Qos。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

setBucketStorageCapacity

void setBucketStorageCapacity(SetBucketStorageCapacityRequest setBucketStorageCapacityRequest)
                              throws OSSException,
                                     ClientException

设置Bucket的容量。

参数:

setBucketStorageCapacityRequest - 请求信息。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketStorageCapacity

UserQos getBucketStorageCapacity(String bucketName)
                                 throws OSSException,
                                        ClientException

获取Bucket的容量。

参数:

bucketName - 指定Bucket名称。

返回:

Bucket的容量配置。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getBucketStorageCapacity

UserQos getBucketStorageCapacity(GenericRequest genericRequest)
                                 throws OSSException,
                                        ClientException

获取Bucket的容量。

参数:

genericRequest - 请求信息。

返回:

Bucket的容量配置。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

uploadFile

UploadFileResult uploadFile(UploadFileRequest uploadFileRequest)
                            throws Throwable

文件上传 上传的文件分成若干个分片分别上传，最后所有分片都上传 成功后，完成整个文件的上传。 在上传的过程中会记录当前上传的进度信息，记 录在checkpoint文件中。 如果上传过程中某一分片上传失败，再次上传时会从 checkpoint文件中记录的点继续上传。 这要求再次调用时要指定与上次相同的 checkpoint文件。上传完成后checkpoint文件会被删除。 默认一个线程、不开启checkpoint。

参数:

uploadFileRequest上传文件请求。 -

返回:

文件上传是否成功，及每个分片上传是否成功。

抛出:

Throwable

downloadFile

DownloadFileResult downloadFile(DownloadFileRequest downloadFileRequest)
                                throws Throwable

文件下载 实现原理是将要下载的Object分成若干个分片分别下载，最后所有分片都下 载成功后，完成整个文件的下载。 在下载的过程中会记录当前下载的进度信息 （记录在checkpoint文件中）和已下载的分片， 如果下载过程中某一分片下载失败，再次下 载时会从checkpoint文件中记录的点继续下载。 这要求再次调用时要指定与上次 相同的checkpoint文件。下载完成后，checkpoint文件会被删除。 默认一个线程、不开启checkpoint。

参数:

downloadFileRequest分片下载请求。 -

返回:

文件上传是否成功、每个分片上传是否成功，及ObjectMetadata。

抛出:

Throwable

createLiveChannel

CreateLiveChannelResult createLiveChannel(CreateLiveChannelRequest createLiveChannelRequest)
                                          throws OSSException,
                                                 ClientException

创建Live Channel。 OSS通过Live Channel，即“直播频道”，来管理RTMP推流；用户想要推送RTMP流到OSS，必须先通过本接口来创建Live Channel。

参数:

createLiveChannelRequest - 请求参数。

返回:

请求结果CreateLiveChannelResult实例。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

setLiveChannelStatus

void setLiveChannelStatus(String bucketName,
                        String liveChannel,
                        LiveChannelStatus status)
                          throws OSSException,
                                 ClientException

设置Live Channel的状态。 通过修改LiveChannel的状态，可实现“禁播”功能。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

status - Live Channel状态，可选值包括enabled、disabled。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

setLiveChannelStatus

void setLiveChannelStatus(SetLiveChannelRequest setLiveChannelRequest)
                          throws OSSException,
                                 ClientException

设置Live Channel的状态。 通过修改LiveChannel的状态，可实现“禁播”功能。

参数:

setLiveChannelRequest - 请求参数。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getLiveChannelInfo

LiveChannelInfo getLiveChannelInfo(String bucketName,
                                 String liveChannel)
                                   throws OSSException,
                                          ClientException

获取Live Channel的配置信息。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

返回:

请求结果LiveChannelInfo实例。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getLiveChannelInfo

LiveChannelInfo getLiveChannelInfo(LiveChannelGenericRequest liveChannelGenericRequest)
                                   throws OSSException,
                                          ClientException

获取Live Channel的配置信息。

参数:

liveChannelGenericRequest - 请求参数。

返回:

请求结果LiveChannelInfo实例。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getLiveChannelStat

LiveChannelStat getLiveChannelStat(String bucketName,
                                 String liveChannel)
                                   throws OSSException,
                                          ClientException

获取Live Channel的推流状态。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

返回:

请求结果LiveChannelStat实例。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getLiveChannelStat

LiveChannelStat getLiveChannelStat(LiveChannelGenericRequest liveChannelGenericRequest)
                                   throws OSSException,
                                          ClientException

获取Live Channel的推流状态。

参数:

liveChannelGenericRequest - 请求参数。

返回:

请求结果LiveChannelStat实例。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteLiveChannel

void deleteLiveChannel(String bucketName,
                     String liveChannel)
                       throws OSSException,
                              ClientException

删除Live Channel。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

deleteLiveChannel

void deleteLiveChannel(LiveChannelGenericRequest liveChannelGenericRequest)
                       throws OSSException,
                              ClientException

删除Live Channel。 删除指定的直播频道。删除频道时，该频道历史上直播生成的视频文件仍然保留。

参数:

liveChannelGenericRequest - 请求参数。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

listLiveChannels

List<LiveChannel> listLiveChannels(String bucketName)
                                   throws OSSException,
                                          ClientException

列出指定Bucket下的所有LiveChannel的列表。

参数:

bucketName - Bucket名称。

返回:

所有LiveChannel的列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

listLiveChannels

LiveChannelListing listLiveChannels(ListLiveChannelsRequest listLiveChannelRequest)
                                    throws OSSException,
                                           ClientException

按照请求参数要求返回的LiveChannel列表。

参数:

listLiveChannelRequest - 请求参数。

返回:

符合请求参数要求的LiveChannel列表。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getLiveChannelHistory

List<LiveRecord> getLiveChannelHistory(String bucketName,
                                     String liveChannel)
                                       throws OSSException,
                                              ClientException

获取指定Live Channel的推流记录。 OSS为每个Live Channel保存最近的10次推流记录。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

返回:

最近的推流记录。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getLiveChannelHistory

List<LiveRecord> getLiveChannelHistory(LiveChannelGenericRequest liveChannelGenericRequest)
                                       throws OSSException,
                                              ClientException

获取指定Live Channel的推流记录。 OSS为每个LiveChannel保存最近的10次推流记录。

参数:

liveChannelGenericRequest - 请求参数。

返回:

最近的次推流记录。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

generateVodPlaylist

void generateVodPlaylist(String bucketName,
                       String liveChannelName,
                       String PlaylistName,
                       long startTime,
                       long endTime)
                         throws OSSException,
                                ClientException

为指定时间段内的ts文件生成一个点播的播放列表（m3u8文件）。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

PlaylistName - 生成的点播用m3u8文件的basename，例如playlist.m3u8。

startTime - 播放列表的开始时间，格式采用epoch time，例如1459922563。

endTime - 播放列表的结束时间，格式采用epoch time，例如1459922563。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

generateVodPlaylist

void generateVodPlaylist(GenerateVodPlaylistRequest generateVodPlaylistRequest)
                         throws OSSException,
                                ClientException

为指定时间段内的ts文件生成一个点播的播放列表（m3u8文件）。

参数:

generateVodPlaylistRequest - 请求参数。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

generateRtmpUri

String generateRtmpUri(String bucketName,
                     String liveChannelName,
                     String PlaylistName,
                     long expires)
                       throws OSSException,
                              ClientException

生成Live Channel的RTMP推流地址。

参数:

bucketName - Bucket名称。

liveChannel - Live Channel名称。

PlaylistName - 生成的点播用m3u8文件的basename，例如playlist.m3u8。

expires - 期望的过期时间，格式采用epoch time，例如1459922563。

返回:

Live Channel的RTMP推流地址。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

generateRtmpUri

String generateRtmpUri(GenerateRtmpUriRequest generatePushflowUrlRequest)
                       throws OSSException,
                              ClientException

生成Live Channel的RTMP推流地址。

参数:

generatePushflowUrlRequest - 请求参数。

返回:

Live Channel的RTMP推流地址。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

createSymlink

void createSymlink(String bucketName,
                 String symlink,
                 String target)
                   throws OSSException,
                          ClientException

参数:

bucketName - Bucket名称。

symlink - 符号链接。

target - 目标文件。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

createSymlink

void createSymlink(CreateSymlinkRequest createSymlinkRequest)
                   throws OSSException,
                          ClientException

创建符号链接。

参数:

createSymlinkRequest - 创建符号链接请求。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getSymlink

OSSSymlink getSymlink(String bucketName,
                    String symlink)
                      throws OSSException,
                             ClientException

获取符号链接的相关信息。

参数:

bucketName - Bucket名称。

symlink - 符号链接。

返回:

符号链接相关的信息，包括目标文件等。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。

getSymlink

OSSSymlink getSymlink(GenericRequest genericRequest)
                      throws OSSException,
                             ClientException

获取符号链接的相关信息。

参数:

genericRequest - 请求，包括bucketName、symLink。

返回:

符号链接相关的信息，包括目标文件等。

抛出:

OSSException - OSS Server异常信息。

ClientException - OSS Client异常信息。