public interface CosXml extends SimpleCosXml
提供用于访问Tencent Cloud COS服务的全面接口。
对象存储(Cloud Object Storage,COS)是腾讯云提供的一种存储海量文件的分布式存储服务,用户可通过网络随时存储和查看数据。腾讯云 COS 使所有用户都能使用具备高扩展性、低成本、可靠和安全的数据存储服务。
CosXml为每个接口都提供了同步和异步操作,如同步接口为headBucket(HeadBucketRequest)
,
则对应的异步接口为headBucketAsync(HeadBucketRequest, CosXmlResultListener)
.
更多信息请参见: 腾讯云COS文档 腾讯云COS XML API文档
注意:这里封装的是COS XML接口,COS JSON接口相关的SDK请参见COS V4,由于COS XML接口相比JSON接口 有更丰富的特性,因此我们更推荐您使用XML SDK。
abortMultiUpload, abortMultiUploadAsync, completeMultiUpload, completeMultiUploadAsync, copyObject, copyObject, copyObjectAsync, copyObjectAsync, deleteObject, deleteObjectAsync, headObject, headObjectAsync, initMultipartUpload, initMultipartUploadAsync, listMultiUploads, listMultiUploadsAsync, listParts, listPartsAsync, postObject, postObjectAsync, preBuildConnection, preBuildConnectionAsync, putObject, putObjectAsync
basePutObject, basePutObjectAsync, cancel, cancelAll, getObject, getObject, getObjectAsync, getObjectUrl, release, uploadPart, uploadPartAsync
GetServiceResult getService(GetServiceRequest request) throws CosXmlClientException, CosXmlServiceException
获取所属账户下所有存储桶列表的同步方法.
通过使用帯 Authorization 签名认证的请求,可以获取签名中 APPID 所属账户的所有存储空间列表 (Bucket list).
API 接口:https://cloud.tencent.com/document/product/436/8291.
SDK 示例:获取存储桶列表示例
request
- 获取所属账户的所有存储空间列表请求 GetServiceRequest
GetServiceResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getServiceAsync(GetServiceRequest request, CosXmlResultListener cosXmlResultListener)
获取所属账户下所有存储桶列表的异步方法.
通过使用帯 Authorization 签名认证的请求,可以获取签名中 APPID 所属账户的所有存储空间列表 (Bucket list).
API 接口:https://cloud.tencent.com/document/product/436/8291.
SDK 示例:获取存储桶列表示例
request
- 获取所属账户的所有存储空间列表请求 GetServiceRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
AppendObjectResult appendObject(AppendObjectRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 追加上传对象的请求 AppendObjectRequest
AppendObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void appendObjectAsync(AppendObjectRequest request, CosXmlResultListener cosXmlResultListener)
request
- 追加上传对象的请求 AppendObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
OptionObjectResult optionObject(OptionObjectRequest request) throws CosXmlClientException, CosXmlServiceException
COS 对象的跨域访问配置预请求的同步方法.
跨域访问配置的预请求是指在发送跨域请求之前会发送一个 OPTIONS 请求并带上特定的来源域,HTTP 方法
和 header 信息等给 COS,以决定是否可以发送真正的跨域请求.
当跨域访问配置不存在时,请求返回403 Forbidden.
跨域访问配置可以通过 putBucketCORS(PutBucketCORSRequest)
或者 putBucketCORSAsync(PutBucketCORSRequest, CosXmlResultListener)
方法来开启 Bucket 的跨域访问
支持.
API 接口:https://cloud.tencent.com/document/product/436/8288.
SDK 示例:预请求跨域配置示例
request
- COS 对象的跨域访问配置预请求 OptionObjectRequest
OptionObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void optionObjectAsync(OptionObjectRequest request, CosXmlResultListener cosXmlResultListener)
COS 对象的跨域访问配置预请求的异步方法.
跨域访问配置的预请求是指在发送跨域请求之前会发送一个 OPTIONS 请求并带上特定的来源域,HTTP 方法
和 header 信息等给 COS,以决定是否可以发送真正的跨域请求.
当跨域访问配置不存在时,请求返回403 Forbidden.
跨域访问配置可以通过 putBucketCORS(PutBucketCORSRequest)
或者 putBucketCORSAsync(PutBucketCORSRequest, CosXmlResultListener)
方法来开启 Bucket 的跨域访问
支持.
API 接口:https://cloud.tencent.com/document/product/436/8288.
SDK 示例:预请求跨域配置示例
request
- COS 对象的跨域访问配置预请求 OptionObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteMultiObjectResult deleteMultiObject(DeleteMultiObjectRequest request) throws CosXmlClientException, CosXmlServiceException
批量删除 COS 对象的同步方法.
COS 支持批量删除指定 Bucket 中 对象,单次请求最大支持批量删除 1000 个 对象.
请求中删除一个不存在的对象,仍然认为是成功的.
对于响应结果,COS提供 Verbose 和 Quiet 两种模式:Verbose 模式将返回每个对象的删除结果;Quiet 模式只返回删除报错的对象信息. 可以通过DeleteMultiObjectRequest.setQuiet(boolean)
设置
API 接口:https://cloud.tencent.com/document/product/436/8289.
SDK 示例:删除多个对象示例
request
- 批量删除 COS 对象请求 DeleteMultiObjectRequest
DeleteMultiObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteMultiObjectAsync(DeleteMultiObjectRequest request, CosXmlResultListener cosXmlResultListener)
批量删除 COS 对象的异步方法.
COS 支持批量删除指定 Bucket 中 对象,单次请求最大支持批量删除 1000 个 对象.
请求中删除一个不存在的对象,仍然认为是成功的.
对于响应结果,COS提供 Verbose 和 Quiet 两种模式:Verbose 模式将返回每个对象的删除结果;Quiet 模式只返回删除报错的对象信息. 可以通过DeleteMultiObjectRequest.setQuiet(boolean)
设置
API 接口:https://cloud.tencent.com/document/product/436/8289.
SDK 示例:删除多个对象示例
request
- 批量删除 COS 对象请求 DeleteMultiObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
RestoreResult restoreObject(RestoreRequest request) throws CosXmlClientException, CosXmlServiceException
恢复归档对象的同步方法.
该请求用于将归档类型的对象取回。
API 接口:https://cloud.tencent.com/document/product/436/12633.
SDK 示例:恢复归档对象示例
request
- 恢复归档对象请求 RestoreRequest
RestoreResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void restoreObjectAsync(RestoreRequest request, CosXmlResultListener cosXmlResultListener)
恢复归档对象的异步方法.
该请求用于将归档类型的对象取回。
API 接口:https://cloud.tencent.com/document/product/436/12633.
SDK 示例:恢复归档对象示例
request
- 恢复归档对象请求 RestoreRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketResult getBucket(GetBucketRequest request) throws CosXmlClientException, CosXmlServiceException
查询存储桶(Bucket) 下的部分或者全部对象的同步方法.
COS 支持列出指定 Bucket 下的部分或者全部对象.
API 接口:https://cloud.tencent.com/document/product/436/7734.
SDK 示例:查询对象列表示例
request
- 查询 Bucket 下的部分或者全部对象请求 GetBucketRequest
GetBucketResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketAsync(GetBucketRequest request, CosXmlResultListener cosXmlResultListener)
查询存储桶(Bucket) 下的部分或者全部对象的异步方法.
COS 支持列出指定 Bucket 下的部分或者全部对象.
API 接口:https://cloud.tencent.com/document/product/436/7734.
SDK 示例:查询对象列表示例
request
- 查询 Bucket 下的部分或者全部对象请求 GetBucketRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketResult putBucket(PutBucketRequest request) throws CosXmlClientException, CosXmlServiceException
创建存储桶(Bucket)的同步方法.
在开始使用 COS 时,需要在指定的账号下先创建一个 Bucket 以便于对象的使用和管理. 并指定 Bucket 所属的地域.创建 Bucket 的用户默认成为 Bucket 的持有者.若创建 Bucket 时没有指定访问权限,则默认 为私有读写(private)权限.
可用地域,可以查看https://cloud.tencent.com/document/product/436/6224.
功能描述:
https://cloud.tencent.com/document/product/436/14106.
API 接口:
https://cloud.tencent.com/document/product/436/7738.
SDK 示例:创建存储桶示例
request
- 创建 Bucket请求 PutBucketRequest
PutBucketResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketAsync(PutBucketRequest request, CosXmlResultListener cosXmlResultListener)
创建存储桶(Bucket)的异步方法.
在开始使用 COS 时,需要在指定的账号下先创建一个 Bucket 以便于对象的使用和管理. 并指定 Bucket 所属的地域.创建 Bucket 的用户默认成为 Bucket 的持有者.若创建 Bucket 时没有指定访问权限,则默认 为私有读写(private)权限.
可用地域,可以查看https://cloud.tencent.com/document/product/436/6224.
功能描述:
https://cloud.tencent.com/document/product/436/14106.
API 接口:
https://cloud.tencent.com/document/product/436/7738.
SDK 示例:创建存储桶示例
request
- 创建 Bucket 请求 PutBucketRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
HeadBucketResult headBucket(HeadBucketRequest request) throws CosXmlClientException, CosXmlServiceException
存储桶(Bucket) 是否存在的同步方法.
在开始使用 Bucket 时,需要确认该 Bucket 是否存在,是否有权限访问.若不存在,则可以调用putBucket(PutBucketRequest)
创建.
API 接口:https://cloud.tencent.com/document/product/436/7735.
SDK 示例:查询对象列表示例
request
- Bucket 是否存在请求 HeadBucketRequest
HeadBucketResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void headBucketAsync(HeadBucketRequest request, CosXmlResultListener cosXmlResultListener)
存储桶(Bucket) 是否存在的异步方法.
在开始使用 Bucket 时,需要确认该 Bucket 是否存在,是否有权限访问.若不存在,则可以调用putBucket(PutBucketRequest)
创建.
API 接口:https://cloud.tencent.com/document/product/436/7735.
SDK 示例:查询对象列表示例
request
- Bucket 是否存在请求 HeadBucketRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketResult deleteBucket(DeleteBucketRequest request) throws CosXmlClientException, CosXmlServiceException
删除存储桶 (Bucket)的同步方法.
COS 目前仅支持删除已经清空的 Bucket,如果 Bucket 中仍有对象,将会删除失败. 因此,在执行删除 Bucket
前,需确保 Bucket 内已经没有对象. 删除 Bucket 时,还需要确保操作的身份已被授权该操作,并确认
传入了正确的存储桶名称和地域参数, 请参阅 putBucket(PutBucketRequest)
.
功能描述:https://cloud.tencent.com/document/product/436/14105.
API 接口:https://cloud.tencent.com/document/product/436/7732.
SDK 示例:删除存储桶示例
request
- 删除 Bucket 请求 DeleteBucketRequest
DeleteBucketResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketAsync(DeleteBucketRequest request, CosXmlResultListener cosXmlResultListener)
删除存储桶 (Bucket)的异步方法.
COS 目前仅支持删除已经清空的 Bucket,如果 Bucket 中仍有对象,将会删除失败. 因此,在执行删除 Bucket
前,需确保 Bucket 内已经没有对象. 删除 Bucket 时,还需要确保操作的身份已被授权该操作,并确认
传入了正确的存储桶名称和地域参数, 请参阅 putBucket(PutBucketRequest)
.
功能描述:https://cloud.tencent.com/document/product/436/14105.
API 接口:https://cloud.tencent.com/document/product/436/7732.
SDK 示例:删除存储桶示例
request
- 删除 Bucket 请求 GetServiceRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetObjectACLResult getObjectACL(GetObjectACLRequest request) throws CosXmlClientException, CosXmlServiceException
获取 COS 对象的访问权限信息(Access Control List, ACL)的同步方法.
Bucket 的持有者可获取该 Bucket 下的某个对象的 ACL 信息,如被授权者以及被授权的信息. ACL 权限包括读、写、读写权限.
API 接口:https://cloud.tencent.com/document/product/436/7744.
SDK 示例:查询对象ACL示例
request
- 获取 COS 对象的 ACL 请求 GetObjectACLRequest
GetObjectACLResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getObjectACLAsync(GetObjectACLRequest request, CosXmlResultListener cosXmlResultListener)
Bucket 的持有者可获取该 Bucket 下的某个对象的 ACL 信息,如被授权者以及被授权的信息. ACL 权限包括读、写、读写权限.
API 接口:https://cloud.tencent.com/document/product/436/7744.
SDK 示例:查询对象ACL示例
request
- 获取 COS 对象的 ACL 请求 GetObjectACLRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutObjectACLResult putObjectACL(PutObjectACLRequest request) throws CosXmlClientException, CosXmlServiceException
设置 COS 对象的访问权限信息(Access Control List, ACL)的同步方法.
ACL权限包括读、写、读写权限. COS 对象的 ACL 可以通过 header头部:"x-cos-acl","x-cos-grant-read","x-cos-grant-write", "x-cos-grant-full-control" 传入 ACL 信息,或者通过 Body 以 XML 格式传入 ACL 信息.这两种方式只 能选择其中一种,否则引起冲突. 传入新的 ACL 将覆盖原有 ACL信息.ACL策略数上限1000,建议用户不要每个上传文件都设置 ACL.
API 接口:https://cloud.tencent.com/document/product/436/7748.
SDK 示例:设置对象ACL示例
request
- 设置 COS 对象的 ACL 请求 PutObjectACLRequest
PutObjectACLResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putObjectACLAsync(PutObjectACLRequest request, CosXmlResultListener cosXmlResultListener)
设置 COS 对象的访问权限信息(Access Control List, ACL)的异步方法.
ACL权限包括读、写、读写权限. COS 对象的 ACL 可以通过 header头部:"x-cos-acl","x-cos-grant-read","x-cos-grant-write", "x-cos-grant-full-control" 传入 ACL 信息,或者通过 Body 以 XML 格式传入 ACL 信息.这两种方式只 能选择其中一种,否则引起冲突. 传入新的 ACL 将覆盖原有 ACL信息.ACL策略数上限1000,建议用户不要每个上传文件都设置 ACL.
API 接口:https://cloud.tencent.com/document/product/436/7748.
SDK 示例:设置对象ACL示例
request
- 设置COS 对象的ACL请求 PutObjectACLRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetObjectTaggingResult getObjectTagging(GetObjectTaggingRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 获取对象标签请求 GetObjectTaggingRequest
GetObjectTaggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getObjectTaggingAsync(GetObjectTaggingRequest request, CosXmlResultListener cosXmlResultListener)
request
- 获取对象标签请求 GetObjectTaggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutObjectTaggingResult putObjectTagging(PutObjectTaggingRequest request) throws CosXmlClientException, CosXmlServiceException
设置对象标签的同步方法.
该请求用于为对象设置键值对作为对象标签,可以协助您管理已有的对象资源,并通过标签进行成本管理。
API 接口:https://cloud.tencent.com/document/product/436/42997.
request
- 设置对象标签请求 PutObjectTaggingRequest
PutObjectTaggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putObjectTaggingAsync(PutObjectTaggingRequest request, CosXmlResultListener cosXmlResultListener)
设置对象标签的异步方法.
该请求用于为对象设置键值对作为对象标签,可以协助您管理已有的对象资源,并通过标签进行成本管理。
API 接口:https://cloud.tencent.com/document/product/436/42997.
request
- 设置对象标签请求 PutObjectTaggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteObjectTaggingResult deleteObjectTagging(DeleteObjectTaggingRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 删除对象标签请求 DeleteObjectTaggingRequest
DeleteObjectTaggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteObjectTaggingAsync(DeleteObjectTaggingRequest request, CosXmlResultListener cosXmlResultListener)
request
- 删除对象标签请求 DeleteObjectTaggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketCORSResult getBucketCORS(GetBucketCORSRequest request) throws CosXmlClientException, CosXmlServiceException
查询存储桶(Bucket) 跨域访问配置信息的同步方法.
COS 支持查询当前 Bucket 跨域访问配置信息,以确定是否配置跨域信息.当跨域访问配置不存在时,请求
返回403 Forbidden.
跨域访问配置可以通过 putBucketCORS(PutBucketCORSRequest)
或者 putBucketCORSAsync(PutBucketCORSRequest, CosXmlResultListener)
方法来开启 Bucket 的跨域访问
支持.
API 接口:https://cloud.tencent.com/document/product/436/8274.
SDK 示例:查询跨域配置示例
request
- 查询 Bucket 跨域访问配置信息请求 GetBucketCORSRequest
GetBucketCORSResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketCORSAsync(GetBucketCORSRequest request, CosXmlResultListener cosXmlResultListener)
查询存储桶(Bucket) 跨域访问配置信息的异步方法.
COS 支持查询当前 Bucket 跨域访问配置信息,以确定是否配置跨域信息.当跨域访问配置不存在时,请求
返回403 Forbidden.
跨域访问配置可以通过 putBucketCORS(PutBucketCORSRequest)
或者 putBucketCORSAsync(PutBucketCORSRequest, CosXmlResultListener)
方法来开启 Bucket 的跨域访问
支持.
API 接口:https://cloud.tencent.com/document/product/436/8274.
SDK 示例:查询跨域配置示例
request
- 查询 Bucket 跨域访问配置信息请求 GetBucketCORSRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketCORSResult putBucketCORS(PutBucketCORSRequest request) throws CosXmlClientException, CosXmlServiceException
设置存储桶(Bucket) 的跨域配置信息的同步方法.
跨域访问配置的预请求是指在发送跨域请求之前会发送一个 OPTIONS 请求并带上特定的来源域,HTTP 方 法和 header 信息等给 COS,以决定是否可以发送真正的跨域请求. 当跨域访问配置不存在时,请求返回403 Forbidden.
默认情况下,Bucket的持有者可以直接配置 Bucket的跨域信息 ,Bucket 持有者也可以将配置权限授予其他用户.新的配置是覆盖当前的所有配置信 息,而不是新增一条配置.可以通过传入 XML 格式的配置文件来实现配置,文件大小限制为64 KB.
API 接口:
https://cloud.tencent.com/document/product/436/8279.
SDK 示例:设置跨域配置示例
request
- 设置 Bucket 的跨域配置信息请求 PutBucketCORSRequest
PutBucketCORSResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketCORSAsync(PutBucketCORSRequest request, CosXmlResultListener cosXmlResultListener)
设置存储桶(Bucket) 的跨域配置信息的异步方法.
跨域访问配置的预请求是指在发送跨域请求之前会发送一个 OPTIONS 请求并带上特定的来源域,HTTP 方 法和 header 信息等给 COS,以决定是否可以发送真正的跨域请求. 当跨域访问配置不存在时,请求返回403 Forbidden.
默认情况下,Bucket的持有者可以直接配置 Bucket的跨域信息 ,Bucket 持有者也可以将配置权限授予其他用户.新的配置是覆盖当前的所有配置信 息,而不是新增一条配置.可以通过传入 XML 格式的配置文件来实现配置,文件大小限制为64 KB.
API 接口:
https://cloud.tencent.com/document/product/436/8279.
SDK 示例:设置跨域配置示例
request
- 设置 Bucket 的跨域配置信息请求 PutBucketCORSRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketCORSResult deleteBucketCORS(DeleteBucketCORSRequest request) throws CosXmlClientException, CosXmlServiceException
删除跨域访问配置信息的同步方法.
若是 Bucket 不需要支持跨域访问配置,可以调用此接口删除已配置的跨域访问信息.
跨域访问配置可以通过 putBucketCORS(PutBucketCORSRequest)
或者 putBucketCORSAsync(PutBucketCORSRequest, CosXmlResultListener)
方法来开启 Bucket 的跨域访问
支持.
API 接口:https://cloud.tencent.com/document/product/436/8283.
SDK 示例:删除跨域配置示例
request
- 删除跨域访问配置信息请求 DeleteBucketCORSRequest
DeleteBucketCORSResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketCORSAsync(DeleteBucketCORSRequest request, CosXmlResultListener cosXmlResultListener)
删除跨域访问配置信息的异步方法.
若是 Bucket 不需要支持跨域访问配置,可以调用此接口删除已配置的跨域访问信息.
跨域访问配置可以通过 putBucketCORS(PutBucketCORSRequest)
或者 putBucketCORSAsync(PutBucketCORSRequest, CosXmlResultListener)
方法来开启 Bucket 的跨域访问
支持.
API 接口:https://cloud.tencent.com/document/product/436/8283.
SDK 示例:删除跨域配置示例
request
- 删除跨域访问配置信息请求 DeleteBucketCORSRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketLifecycleResult getBucketLifecycle(GetBucketLifecycleRequest request) throws CosXmlClientException, CosXmlServiceException
查询存储桶(Bucket) 的生命周期配置的同步方法.
COS 支持以生命周期配置的方式来管理 Bucket 中对象的生命周期,生命周期配置包含一个或多个将
应用于一组对象规则的规则集 (其中每个规则为 COS 定义一个操作),请参阅 putBucketLifecycle(PutBucketLifecycleRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/8278.
SDK 示例:查询生命周期示例
request
- 查询 Bucket 的生命周期配置请求 GetBucketLifecycleRequest
GetBucketLifecycleResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketLifecycleAsync(GetBucketLifecycleRequest request, CosXmlResultListener cosXmlResultListener)
查询存储桶(Bucket) 的生命周期配置的异步方法.
COS 支持以生命周期配置的方式来管理 Bucket 中对象的生命周期,生命周期配置包含一个或多个将
应用于一组对象规则的规则集 (其中每个规则为 COS 定义一个操作),请参阅 putBucketLifecycle(PutBucketLifecycleRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/8278.
SDK 示例:查询生命周期示例
request
- 查询 Bucket 的生命周期配置请求 GetBucketLifecycleRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketLifecycleResult putBucketLifecycle(PutBucketLifecycleRequest request) throws CosXmlClientException, CosXmlServiceException
设置存储桶(Bucket) 生命周期配置的同步方法.
COS 支持以生命周期配置的方式来管理 Bucket 中对象的生命周期. 如果该 Bucket 已配置生命周期,新的配置的同时则会覆盖原有的配置. 生命周期配置包含一个或多个将应用于一组对象规则的规则集 (其中每个规则为 COS 定义一个操作)。这些操作分为以下两种:转换操作,过期操作.
API 接口:
https://cloud.tencent.com/document/product/436/8280
SDK 示例:设置生命周期示例
request
- Bucket 生命周期配置请求 PutBucketLifecycleRequest
PutBucketLifecycleResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketLifecycleAsync(PutBucketLifecycleRequest request, CosXmlResultListener cosXmlResultListener)
设置存储桶(Bucket) 生命周期配置的异步方法.
COS 支持以生命周期配置的方式来管理 Bucket 中对象的生命周期. 如果该 Bucket 已配置生命周期,新的配置的同时则会覆盖原有的配置. 生命周期配置包含一个或多个将应用于一组对象规则的规则集 (其中每个规则为 COS 定义一个操作)。这些操作分为以下两种:转换操作,过期操作.
API 接口:
https://cloud.tencent.com/document/product/436/8280
SDK 示例:设置生命周期示例
request
- Bucket 生命周期配置请求 PutBucketLifecycleRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketLifecycleResult deleteBucketLifecycle(DeleteBucketLifecycleRequest request) throws CosXmlClientException, CosXmlServiceException
删除存储桶(Bucket) 的生命周期配置的同步方法.
COS 支持删除已配置的 Bucket 的生命周期列表.
COS 支持以生命周期配置的方式来管理 Bucket 中 对象的生命周期,生命周期配置包含一个或多个将
应用于一组对象规则的规则集 (其中每个规则为 COS 定义一个操作),请参阅 putBucketLifecycle(PutBucketLifecycleRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/8284.
SDK 示例:删除生命周期示例
request
- 删除 Bucket 的生命周期配置请求 GetServiceRequest
DeleteBucketLifecycleResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketLifecycleAsync(DeleteBucketLifecycleRequest request, CosXmlResultListener cosXmlResultListener)
删除存储桶(Bucket) 的生命周期配置的异步方法.
COS 支持删除已配置的 Bucket 的生命周期列表.
COS 支持以生命周期配置的方式来管理 Bucket 中 对象的生命周期,生命周期配置包含一个或多个将
应用于一组对象规则的规则集 (其中每个规则为 COS 定义一个操作),请参阅 putBucketLifecycle(PutBucketLifecycleRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/8284.
SDK 示例:删除生命周期示例
request
- 删除 Bucket 的生命周期配置请求 DeleteBucketLifecycleRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketACLResult getBucketACL(GetBucketACLRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶(Bucket) 的访问权限信息(Access Control List, ACL)的同步方法.
ACL 权限包括读、写、读写权限. COS 中 Bucket 是有访问权限控制的.可以通过获取 Bucket 的 ACL 表(putBucketACL(PutBucketACLRequest)
),来查看那些用户拥有 Bucket 访
问权限.
API 接口: https://cloud.tencent.com/document/product/436/7733.
SDK 示例:查询存储桶ACL示例
request
- 获取 Bucket 的 ACL 请求 GetBucketACLRequest
GetBucketACLResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketACLAsync(GetBucketACLRequest request, CosXmlResultListener cosXmlResultListener)
获取存储桶(Bucket) 的访问权限信息(Access Control List, ACL)的异步方法.
ACL 权限包括读、写、读写权限.COS 中 Bucket 是有访问权限控制的.可以通过获取 Bucket 的 ACL 表(putBucketACL(PutBucketACLRequest)
),来查看那些用户拥有 Bucket 访
问权限.
API 接口: https://cloud.tencent.com/document/product/436/7733.
SDK 示例:查询存储桶ACL示例
request
- 获取 Bucket 的 ACL 请求 GetBucketACLRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketACLResult putBucketACL(PutBucketACLRequest request) throws CosXmlClientException, CosXmlServiceException
设置存储桶(Bucket) 的访问权限(Access Control List, ACL)的同步方法.
ACL 权限包括读、写、读写权限. 写入 Bucket 的 ACL 可以通过 header头部:"x-cos-acl","x-cos-grant-read","x-cos-grant-write", "x-cos-grant-full-control" 传入 ACL 信息,或者通过 Body 以 XML 格式传入 ACL 信息.这两种方式只 能选择其中一种,否则引起冲突. 传入新的 ACL 将覆盖原有 ACL信息. 私有 Bucket 可以下可以给某个文件夹设置成公有,那么该文件夹下的文件都是公有;但是把文件夹设置成私有后,在该文件夹下的文件设置 的公有属性,不会生效.
API 接口:https://cloud.tencent.com/document/product/436/7737.
SDK 示例:设置存储桶ACL示例
request
- 设置 Bucket 的ACL请求 PutBucketACLRequest
PutBucketACLResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketACLAsync(PutBucketACLRequest request, CosXmlResultListener cosXmlResultListener)
设置存储桶(Bucket) 的访问权限(Access Control List, ACL)的异步方法.
ACL 权限包括读、写、读写权限. 写入 Bucket 的 ACL 可以通过 header头部:"x-cos-acl","x-cos-grant-read","x-cos-grant-write", "x-cos-grant-full-control" 传入 ACL 信息,或者通过 Body 以 XML 格式传入 ACL 信息.这两种方式只 能选择其中一种,否则引起冲突. 传入新的 ACL 将覆盖原有 ACL信息. 私有 Bucket 可以下可以给某个文件夹设置成公有,那么该文件夹下的文件都是公有;但是把文件夹设置成私有后,在该文件夹下的文件设置 的公有属性,不会生效.
API 接口:https://cloud.tencent.com/document/product/436/7737.
SDK 示例:设置存储桶ACL示例
request
- 设置 Bucket 的ACL请求 PutBucketACLRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketAccelerateResult getBucketAccelerate(GetBucketAccelerateRequest request) throws CosXmlClientException, CosXmlServiceException
void getBucketAccelerateAsync(GetBucketAccelerateRequest request, CosXmlResultListener cosXmlResultListener)
PutBucketAccelerateResult putBucketAccelerate(PutBucketAccelerateRequest request) throws CosXmlClientException, CosXmlServiceException
void putBucketAccelerateAsync(PutBucketAccelerateRequest request, CosXmlResultListener cosXmlResultListener)
GetBucketLocationResult getBucketLocation(GetBucketLocationRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶(Bucket) 所在的地域信息的同步方法.
在创建 Bucket 时,需要指定所属该 Bucket 所属地域信息.
COS 支持的地域信息,可查看https://cloud.tencent.com/document/product/436/6224.
API 接口:https://cloud.tencent.com/document/product/436/8275.
request
- 获取 Bucket 所在的地域信息请求 GetBucketLocationRequest
GetBucketLocationResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketLocationAsync(GetBucketLocationRequest request, CosXmlResultListener cosXmlResultListener)
获取存储桶(Bucket) 所在的地域信息的异步方法.
在创建 Bucket 时,需要指定所属该 Bucket 所属地域信息.
COS 支持的地域信息,可查看https://cloud.tencent.com/document/product/436/6224.
API 接口:https://cloud.tencent.com/document/product/436/8275.
request
- 获取 Bucket 所在的地域信息请求 GetBucketLocationRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketVersioningResult getBucketVersioning(GetBucketVersioningRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶(Bucket)版本控制信息的同步方法.
通过查询版本控制信息,可以得知该 Bucket 的版本控制功能是处于禁用状态还是启用状态(Enabled 或者 Suspended),
开启版本控制功能,可参考putBucketVersioning(PutBucketVersioningRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/19888.
SDK 示例:查询存储桶版本控制示例
request
- 获取 Bucket 版本控制信息请求 GetBucketVersioningRequest
GetBucketVersioningResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketVersioningAsync(GetBucketVersioningRequest request, CosXmlResultListener cosXmlResultListener)
获取存储桶(Bucket)版本控制信息的异步方法.
通过查询版本控制信息,可以得知该 Bucket 的版本控制功能是处于禁用状态还是启用状态(Enabled 或者 Suspended),
开启版本控制功能,可参考putBucketVersioning(PutBucketVersioningRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/19888.
SDK 示例:查询存储桶版本控制示例
request
- 获取 Bucket 版本控制信息请求 GetBucketVersioningRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketVersioningResult putBucketVersioning(PutBucketVersioningRequest request) throws CosXmlClientException, CosXmlServiceException
设置存储桶(Bucket)版本控制的同步方法.
版本管理功能一经打开,只能暂停,不能关闭. 通过版本控制,可以在一个 Bucket 中保留一个对象的多个版本. 版本控制可以防止意外覆盖和删除对象,以便检索早期版本的对象. 默认情况下,版本控制功能处于禁用状态,需要主动去启用或者暂停(Enabled 或者 Suspended).
API 接口:https://cloud.tencent.com/document/product/436/19888.
SDK 示例:设置存储桶版本控制示例
request
- Bucket 版本控制启用或者暂停请求 PutBucketVersioningRequest
PutBucketVersioningResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketVersionAsync(PutBucketVersioningRequest request, CosXmlResultListener cosXmlResultListener)
设置存储桶(Bucket)版本控制的异步方法.
版本管理功能一经打开,只能暂停,不能关闭. 通过版本控制,可以在一个 Bucket 中保留一个对象的多个版本. 版本控制可以防止意外覆盖和删除对象,以便检索早期版本的对象. 默认情况下,版本控制功能处于禁用状态,需要主动去启用或者暂停(Enabled 或者 Suspended).
API 接口:https://cloud.tencent.com/document/product/436/19888.
SDK 示例:设置存储桶版本控制示例
request
- Bucket 版本控制启用或者暂停请求 PutBucketVersioningRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketReplicationResult getBucketReplication(GetBucketReplicationRequest request) throws CosXmlClientException, CosXmlServiceException
获取跨区域复制配置信息的同步方法.
跨区域复制是支持不同区域 Bucket 自动异步复制对象, 请查阅putBucketReplication(PutBucketReplicationRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/19222.
SDK 示例:查询跨地域复制示例
request
- 获取跨区域复制配置信息请求 GetBucketReplicationRequest
GetBucketReplicationResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketReplicationAsync(GetBucketReplicationRequest request, CosXmlResultListener cosXmlResultListener)
获取跨区域复制配置信息的异步方法.
跨区域复制是支持不同区域 Bucket 自动异步复制对象, 请查阅putBucketReplication(PutBucketReplicationRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/19222.
SDK 示例:查询跨地域复制示例
request
- 获取跨区域复制配置信息请求 GetBucketReplicationRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketReplicationResult putBucketReplication(PutBucketReplicationRequest request) throws CosXmlClientException, CosXmlServiceException
配置跨区域复制的同步方法.
跨区域复制是支持不同区域 Bucket 自动异步复制对象.注意,不能是同区域的 Bucket, 且源 Bucket 和目
标 Bucket 必须已启用版本控制putBucketVersioning(PutBucketVersioningRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/19223.
SDK 示例:设置跨地域复制示例
request
- 配置跨区域复制请求 PutBucketReplicationRequest
PutBucketReplicationResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketReplicationAsync(PutBucketReplicationRequest request, CosXmlResultListener cosXmlResultListener)
配置跨区域复制的异步方法.
跨区域复制是支持不同区域 Bucket 自动异步复制对象.注意,不能是同区域的 Bucket, 且源 Bucket 和目
标 Bucket 必须已启用版本控制putBucketVersioning(PutBucketVersioningRequest)
.
API 接口:https://cloud.tencent.com/document/product/436/19223.
SDK 示例:设置跨地域复制示例
request
- 配置跨区域复制请求 PutBucketReplicationRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketReplicationResult deleteBucketReplication(DeleteBucketReplicationRequest request) throws CosXmlClientException, CosXmlServiceException
删除跨区域复制配置的同步方法.
当不需要进行跨区域复制时,可以删除 Bucket 的跨区域复制配置. 跨区域复制,可以查阅putBucketReplication(PutBucketReplicationRequest)
API 接口:https://cloud.tencent.com/document/product/436/19221.
SDK 示例:删除跨地域复制示例
request
- 删除跨区域复制配置请求 DeleteBucketReplicationRequest
DeleteBucketReplicationResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketReplicationAsync(DeleteBucketReplicationRequest request, CosXmlResultListener cosXmlResultListener)
删除跨区域复制配置的异步方法.
当不需要进行跨区域复制时,可以删除 Bucket 的跨区域复制配置. 跨区域复制,可以查阅putBucketReplication(PutBucketReplicationRequest)
API 接口:https://cloud.tencent.com/document/product/436/19221.
SDK 示例:删除跨地域复制示例
request
- 删除跨区域复制配置请求 DeleteBucketReplicationRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
ListBucketVersionsResult listBucketVersions(ListBucketVersionsRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶(Bucket)所有或者部分对象的版本信息的同步方法.
通过查看对象的版本信息,可以得知对象存在哪些版本,便于管理对象.如检索或者删除某个特定版本的对象.
版本管理功能,请查阅putBucketVersioning(PutBucketVersioningRequest)
API 接口:https://cloud.tencent.com/document/product/436/35521.
request
- 获取 Bucket 所有或者部分对象的版本信息请求 ListBucketVersionsRequest
ListBucketVersionsResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void listBucketVersionsAsync(ListBucketVersionsRequest request, CosXmlResultListener cosXmlResultListener)
获取存储桶(Bucket)所有或者部分对象的版本信息的异步方法.
通过查看对象的版本信息,可以得知对象存在哪些版本,便于管理对象.如检索或者删除某个特定版本的对象.
版本管理功能,请查阅putBucketVersioning(PutBucketVersioningRequest)
API 接口:https://cloud.tencent.com/document/product/436/35521.
request
- 获取 Bucket 所有或者部分对象的版本信息请求 ListBucketVersionsRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketWebsiteResult getBucketWebsite(GetBucketWebsiteRequest request) throws CosXmlClientException, CosXmlServiceException
查询与存储桶关联的静态网站配置信息的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/31929.
SDK 示例:查询静态网站配置示例
request
- 查询与存储桶关联的静态网站配置信息的请求 GetBucketWebsiteRequest
GetBucketWebsiteResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketWebsiteAsync(GetBucketWebsiteRequest request, CosXmlResultListener cosXmlResultListener)
查询与存储桶关联的静态网站配置信息的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/31929.
SDK 示例:查询静态网站配置示例
request
- 查询与存储桶关联的静态网站配置信息的请求 GetBucketWebsiteRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketWebsiteResult putBucketWebsite(PutBucketWebsiteRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 设置存储桶静态网站请求 PutBucketWebsiteRequest
PutBucketWebsiteResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketWebsiteAsync(PutBucketWebsiteRequest request, CosXmlResultListener cosXmlResultListener)
request
- 设置存储桶静态网站请求 PutBucketWebsiteRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketWebsiteResult deleteBucketWebsite(DeleteBucketWebsiteRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 删除存储桶中静态网站配置的请求 DeleteBucketWebsiteRequest
DeleteBucketWebsiteResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketWebsiteAsync(DeleteBucketWebsiteRequest request, CosXmlResultListener cosXmlResultListener)
request
- 删除存储桶中静态网站配置的请求 DeleteBucketWebsiteRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketLoggingResult getBucketLogging(GetBucketLoggingRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 用于查询指定存储桶日志配置信息的请求 GetBucketLoggingRequest
GetBucketLoggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketLoggingAsync(GetBucketLoggingRequest request, CosXmlResultListener cosXmlResultListener)
request
- 用于查询指定存储桶日志配置信息的请求 GetBucketLoggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketLoggingResult putBucketLogging(PutBucketLoggingRequest request) throws CosXmlClientException, CosXmlServiceException
为源存储桶开启日志记录的同步方法.
该请求用于为源存储桶开启日志记录,将源存储桶的访问日志保存到指定的目标存储桶中
API 接口:https://cloud.tencent.com/document/product/436/17054.
SDK 示例:设置日志管理示例
request
- 为源存储桶开启日志记录的请求 PutBucketLoggingRequest
PutBucketLoggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketLoggingAsync(PutBucketLoggingRequest request, CosXmlResultListener cosXmlResultListener)
为源存储桶开启日志记录的异步方法.
该请求用于为源存储桶开启日志记录,将源存储桶的访问日志保存到指定的目标存储桶中
API 接口:https://cloud.tencent.com/document/product/436/17054.
SDK 示例:设置日志管理示例
request
- 为源存储桶开启日志记录的请求 PutBucketLoggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketTaggingResult getBucketTagging(GetBucketTaggingRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 查询存储桶标签的请求 GetBucketTaggingRequest
GetBucketTaggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketTaggingAsync(GetBucketTaggingRequest request, CosXmlResultListener cosXmlResultListener)
request
- 查询存储桶标签的请求 GetBucketTaggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketTaggingResult putBucketTagging(PutBucketTaggingRequest request) throws CosXmlClientException, CosXmlServiceException
为已存在的存储桶设置标签的同步方法.
该请求用于为存储桶设置键值对作为存储桶标签,可以协助您管理已有的存储桶资源,并通过标签进行成本管理。
API 接口:https://cloud.tencent.com/document/product/436/34838.
SDK 示例:设置存储桶标签示例
request
- 为已存在的存储桶设置标签的请求 PutBucketTaggingRequest
PutBucketTaggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketTaggingAsync(PutBucketTaggingRequest request, CosXmlResultListener cosXmlResultListener)
为已存在的存储桶设置标签的异步方法.
该请求用于为存储桶设置键值对作为存储桶标签,可以协助您管理已有的存储桶资源,并通过标签进行成本管理。
API 接口:https://cloud.tencent.com/document/product/436/34838.
SDK 示例:设置存储桶标签示例
request
- 为已存在的存储桶设置标签的请求 PutBucketTaggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketTaggingResult deleteBucketTagging(DeleteBucketTaggingRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 删除存储桶标签的请求 DeleteBucketTaggingRequest
DeleteBucketTaggingResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketTaggingAsync(DeleteBucketTaggingRequest request, CosXmlResultListener cosXmlResultListener)
request
- 删除存储桶标签的请求 DeleteBucketTaggingRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketInventoryResult getBucketInventory(GetBucketInventoryRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 获取存储桶中清单任务的请求 GetBucketInventoryRequest
GetBucketInventoryResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketInventoryAsync(GetBucketInventoryRequest request, CosXmlResultListener cosXmlResultListener)
request
- 获取存储桶中清单任务的请求 GetBucketInventoryRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketInventoryResult putBucketInventory(PutBucketInventoryRequest request) throws CosXmlClientException, CosXmlServiceException
在存储桶中创建清单任务的同步方法.
在存储桶中创建清单任务,您可以对清单任务命名后,使用该请求创建清单任务。
API 接口:https://cloud.tencent.com/document/product/436/33707.
SDK 示例:设置清单任务示例
request
- 在存储桶中创建清单任务的请求 PutBucketInventoryRequest
PutBucketInventoryResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketInventoryAsync(PutBucketInventoryRequest request, CosXmlResultListener cosXmlResultListener)
在存储桶中创建清单任务的异步方法.
在存储桶中创建清单任务,您可以对清单任务命名后,使用该请求创建清单任务。
API 接口:https://cloud.tencent.com/document/product/436/33707.
SDK 示例:设置清单任务示例
request
- 在存储桶中创建清单任务的请求 PutBucketInventoryRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketInventoryResult deleteBucketInventory(DeleteBucketInventoryRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 删除存储桶中指定清单任务的请求 DeleteBucketInventoryRequest
DeleteBucketInventoryResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketInventoryAsync(DeleteBucketInventoryRequest request, CosXmlResultListener cosXmlResultListener)
request
- 删除存储桶中指定清单任务的请求 DeleteBucketInventoryRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
ListBucketInventoryResult listBucketInventory(ListBucketInventoryRequest request) throws CosXmlClientException, CosXmlServiceException
查询存储桶中所有清单任务的同步方法.
用于请求返回一个存储桶中的所有清单任务。每一个存储桶中最多配置1000条清单任务。
API 接口:https://cloud.tencent.com/document/product/436/33706.
request
- 查询存储桶中所有清单任务的请求 ListBucketInventoryRequest
ListBucketInventoryResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void listBucketInventoryAsync(ListBucketInventoryRequest request, CosXmlResultListener cosXmlResultListener)
查询存储桶中所有清单任务的异步方法.
用于请求返回一个存储桶中的所有清单任务。每一个存储桶中最多配置1000条清单任务。
API 接口:https://cloud.tencent.com/document/product/436/33706.
request
- 查询存储桶中所有清单任务的请求 ListBucketInventoryRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketDomainResult putBucketDomain(PutBucketDomainRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 为存储桶配置自定义域名的请求 PutBucketDomainRequest
PutBucketDomainResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketDomainAsync(PutBucketDomainRequest request, CosXmlResultListener cosXmlResultListener)
request
- 为存储桶配置自定义域名的请求 PutBucketDomainRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketDomainResult getBucketDomain(GetBucketDomainRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 查询存储桶自定义域名信息的请求 GetBucketDomainRequest
GetBucketDomainResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketDomainAsync(GetBucketDomainRequest request, CosXmlResultListener cosXmlResultListener)
request
- 查询存储桶自定义域名信息的请求 GetBucketDomainRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketDomainResult deleteBucketDomain(DeleteBucketDomainRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 删除存储桶自定义域名信息的请求 DeleteBucketDomainRequest
DeleteBucketDomainResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketDomainAsync(DeleteBucketDomainRequest request, CosXmlResultListener cosXmlResultListener)
request
- 删除存储桶自定义域名信息的请求 DeleteBucketDomainRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketRefererResult getBucketReferer(GetBucketRefererRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶防盗链配置的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/32493.
request
- 获取存储桶防盗链配置的请求 GetBucketRefererRequest
GetBucketRefererResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketRefererAsync(GetBucketRefererRequest request, CosXmlResultListener cosXmlResultListener)
获取存储桶防盗链配置的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/32493.
request
- 查询与存储桶关联的静态网站配置信息的请求 GetBucketRefererRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketRefererResult putBucketReferer(PutBucketRefererRequest request) throws CosXmlClientException, CosXmlServiceException
设置存储桶防盗链的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/32492.
request
- 设置存储桶防盗链请求 PutBucketRefererRequest
PutBucketRefererResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketRefererAsync(PutBucketRefererRequest request, CosXmlResultListener cosXmlResultListener)
设置存储桶防盗链的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/32492.
request
- 设置存储桶防盗链请求 PutBucketRefererRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketPolicyResult getBucketPolicy(GetBucketPolicyRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶权限策略配置的同步方法.
request
- 获取存储桶权限策略配置的请求 GetBucketPolicyRequest
GetBucketPolicyResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketPolicyAsync(GetBucketPolicyRequest request, CosXmlResultListener cosXmlResultListener)
获取存储桶权限策略配置的异步方法.
request
- 获取存储桶权限策略配置的请求 GetBucketPolicyRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketPolicyResult putBucketPolicy(PutBucketPolicyRequest request) throws CosXmlClientException, CosXmlServiceException
设置存储桶权限策略的同步方法.
request
- 设置存储桶权限策略请求 PutBucketPolicyRequest
PutBucketPolicyResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketPolicyAsync(PutBucketPolicyRequest request, CosXmlResultListener cosXmlResultListener)
设置存储桶权限策略的异步方法.
request
- 设置存储桶权限策略请求 PutBucketPolicyRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteBucketPolicyResult deleteBucketPolicy(DeleteBucketPolicyRequest request) throws CosXmlClientException, CosXmlServiceException
删除存储桶权限策略的同步方法.
request
- 删除存储桶权限策略请求 DeleteBucketPolicyRequest
DeleteBucketPolicyResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteBucketPolicyAsync(DeleteBucketPolicyRequest request, CosXmlResultListener cosXmlResultListener)
删除存储桶权限策略的异步方法.
request
- 删除存储桶权限策略请求 DeleteBucketPolicyRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
SelectObjectContentResult selectObjectContent(SelectObjectContentRequest request) throws CosXmlClientException, CosXmlServiceException
使用结构化查询语句从指定对象(CSV 格式或者 JSON 格式)中检索内容的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/37641.
request
- 使用结构化查询语句从指定对象中检索内容的请求 SelectObjectContentRequest
SelectObjectContentResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void selectObjectContentAsync(SelectObjectContentRequest request, CosXmlResultListener cosXmlResultListener)
使用结构化查询语句从指定对象(CSV 格式或者 JSON 格式)中检索内容的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/37641.
request
- 使用结构化查询语句从指定对象中检索内容的请求 SelectObjectContentRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketObjectVersionsResult getBucketObjectVersions(GetBucketObjectVersionsRequest request) throws CosXmlClientException, CosXmlServiceException
拉取存储桶内的所有对象及其历史版本信息的同步方法.
用于拉取存储桶内的所有对象及其历史版本信息,您可以通过指定参数筛选出存储桶内部分对象及其历史版本信息。
API 接口:https://cloud.tencent.com/document/product/436/35521.
request
- 拉取存储桶内的所有对象及其历史版本信息的请求 GetBucketObjectVersionsRequest
GetBucketObjectVersionsResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketObjectVersionsAsync(GetBucketObjectVersionsRequest request, CosXmlResultListener cosXmlResultListener)
拉取存储桶内的所有对象及其历史版本信息的异步方法.
用于拉取存储桶内的所有对象及其历史版本信息,您可以通过指定参数筛选出存储桶内部分对象及其历史版本信息。
API 接口:https://cloud.tencent.com/document/product/436/35521.
request
- 拉取存储桶内的所有对象及其历史版本信息的请求 GetBucketObjectVersionsRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PutBucketIntelligentTieringResult putBucketIntelligentTiering(PutBucketIntelligentTieringRequest request) throws CosXmlClientException, CosXmlServiceException
启用存储桶智能分层存储配置能力的同步方法.
启用智能分层能力后,只能进行参数编辑,无法关闭。
API 接口:
request
- 启用存储桶智能分层存储配置能力的请求 PutBucketIntelligentTieringRequest
PutBucketIntelligentTieringResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putBucketIntelligentTieringAsync(PutBucketIntelligentTieringRequest request, CosXmlResultListener cosXmlResultListener)
启用存储桶智能分层存储配置能力的异步方法.
启用智能分层能力后,只能进行参数编辑,无法关闭。
API 接口:
request
- 启用存储桶智能分层存储配置能力的请求 PutBucketIntelligentTieringRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetBucketIntelligentTieringResult getBucketIntelligentTiering(GetBucketIntelligentTieringRequest request) throws CosXmlClientException, CosXmlServiceException
获取存储桶智能分层存储配置能力的同步方法.
API 接口:
request
- 启用存储桶智能分层存储配置能力的请求 GetBucketIntelligentTieringRequest
GetBucketIntelligentTieringResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getBucketIntelligentTieringAsync(GetBucketIntelligentTieringRequest request, CosXmlResultListener resultListener)
取存储桶智能分层存储配置能力的异步方法.
API 接口:
request
- 启用存储桶智能分层存储配置能力的请求 GetBucketIntelligentTieringRequest
resultListener
- 请求回调结果 CosXmlResultListener
PreviewDocumentResult previewDocument(PreviewDocumentRequest request) throws CosXmlClientException, CosXmlServiceException
预览文档的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/54058.
request
- 预览文档的请求 PreviewDocumentRequest
PreviewDocumentResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void previewDocumentAsync(PreviewDocumentRequest request, CosXmlResultListener cosXmlResultListener)
预览文档的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/54058.
request
- 预览文档的请求 PreviewDocumentRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PreviewDocumentInHtmlResult previewDocumentInHtml(PreviewDocumentInHtmlRequest request) throws CosXmlClientException, CosXmlServiceException
以HTML格式预览文档的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/54059.
request
- 以HTML格式预览文档的请求 PreviewDocumentInHtmlRequest
PreviewDocumentInHtmlResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void previewDocumentInHtmlAsync(PreviewDocumentInHtmlRequest request, CosXmlResultListener cosXmlResultListener)
以HTML格式预览文档的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/54059.
request
- 以HTML格式预览文档的请求 PreviewDocumentInHtmlRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PreviewDocumentInHtmlLinkResult previewDocumentInHtmlLink(PreviewDocumentInHtmlLinkRequest request) throws CosXmlClientException, CosXmlServiceException
以HTML格式链接预览文档的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/54060.
request
- 以HTML格式链接预览文档的请求 PreviewDocumentInHtmlLinkRequest
PreviewDocumentInHtmlLinkResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void previewDocumentInHtmlLinkAsync(PreviewDocumentInHtmlLinkRequest request, CosXmlResultListener cosXmlResultListener)
以HTML格式链接预览文档的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/54060.
request
- 以HTML格式链接预览文档的请求 PreviewDocumentInHtmlLinkRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
byte[] previewDocumentInHtmlBytes(java.lang.String bucketName, java.lang.String objectName) throws CosXmlClientException, CosXmlServiceException
以HTML格式直出内容预览文档到字节数组的同步方法
和previewDocumentInHtml(PreviewDocumentInHtmlRequest)
类似,只是返回结果形式不同
注意:请不要通过本接口预览大文件,否则容易造成内存溢出。
bucketName
- 存储桶名称objectName
- 对象远端路径,即存储到 COS 上的绝对路径CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常GetSnapshotResult getSnapshot(GetSnapshotRequest request) throws CosXmlClientException, CosXmlServiceException
获取截图的同步方法
API 接口:https://cloud.tencent.com/document/product/436/55671.request
- 获取截图的同步方法 GetSnapshotRequest
GetSnapshotResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getSnapshotAsync(GetSnapshotRequest request, CosXmlResultListener cosXmlResultListener)
获取截图的异步方法
API 接口:https://cloud.tencent.com/document/product/436/55671.request
- 获取截图的异步方法 GetSnapshotRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetMediaInfoResult getMediaInfo(GetMediaInfoRequest request) throws CosXmlClientException, CosXmlServiceException
request
- 获取媒体文件信息的请求 GetMediaInfoRequest
GetMediaInfoResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getMediaInfoAsync(GetMediaInfoRequest request, CosXmlResultListener cosXmlResultListener)
request
- 获取媒体文件信息的请求 GetMediaInfoRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetDescribeMediaBucketsResult getDescribeMediaBuckets(GetDescribeMediaBucketsRequest request) throws CosXmlClientException, CosXmlServiceException
查询已经开通媒体处理功能的存储桶的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/48988.
SDK 示例:查询已经开通媒体处理功能存储桶的示例
request
- 获取存储桶防盗链配置的请求 GetDescribeMediaBucketsRequest
GetDescribeMediaBucketsResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getDescribeMediaBucketsAsync(GetDescribeMediaBucketsRequest request, CosXmlResultListener cosXmlResultListener)
查询已经开通媒体处理功能的存储桶的异步方法.
API 接口:https://cloud.tencent.com/document/product/436/48988.
SDK 示例:查询已经开通媒体处理功能存储桶的示例
request
- 查询已经开通媒体处理功能的存储桶的请求 GetDescribeMediaBucketsRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
boolean doesBucketExist(java.lang.String bucketName) throws CosXmlClientException, CosXmlServiceException
判断指定的 bucket 是否存在的同步方法。
bucketName
- bucket 名称,如 bucket-1250000000 等CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void doesBucketExistAsync(java.lang.String bucketName, CosXmlBooleanListener booleanListener)
判断指定的 bucket 是否存在的异步方法。
基于 getBucketACLAsync(GetBucketACLRequest, CosXmlResultListener)
实现
bucketName
- bucket 名称,如 bucket-1250000000 等booleanListener
- 结果回调函数boolean doesObjectExist(java.lang.String bucketName, java.lang.String objectName) throws CosXmlClientException, CosXmlServiceException
判断存储桶下指定对象是否存在的同步方法。
bucketName
- bucket 名称, 如 test-1250000000objectName
- 对象在 COS 上的路径,比如 image/me.pngCosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void doesObjectExistAsync(java.lang.String bucketName, java.lang.String objectName, CosXmlBooleanListener booleanListener)
判断存储桶下指定对象是否存在的异步方法。
基于 SimpleCosXml.headObjectAsync(HeadObjectRequest, CosXmlResultListener)
实现
bucketName
- bucket 名称, 如 test-1250000000objectName
- 对象在 COS 上的路径,比如 image/me.pngbooleanListener
- 结果回调函数boolean deleteObject(java.lang.String bucketName, java.lang.String objectName) throws CosXmlClientException, CosXmlServiceException
删除 COS 上单个对象的同步方法。
bucketName
- bucket 名称, 如 test-1250000000objectName
- 对象在 COS 上的路径,比如 image/me.pngCosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteObjectAsync(java.lang.String bucketName, java.lang.String objectName, CosXmlBooleanListener booleanListener)
删除 COS 上单个对象的异步方法。
基于 SimpleCosXml.deleteObjectAsync(DeleteObjectRequest, CosXmlResultListener)
实现
bucketName
- bucket 名称, 如 test-1250000000objectName
- 对象在 COS 上的路径,比如 image/me.pngbooleanListener
- 结果回调函数@Deprecated boolean updateObjectMeta(java.lang.String bucketName, java.lang.String objectName, COSMetaData metaData) throws CosXmlClientException, CosXmlServiceException
更新对象元数据的同步方法。 建议使用updateObjectMetaData(java.lang.String, java.lang.String, com.tencent.cos.xml.model.tag.COSMetaData)
updateObjectMeta(java.lang.String, java.lang.String, com.tencent.cos.xml.model.tag.COSMetaData)
:bucketName不含appid,比如:test
updateObjectMetaData(java.lang.String, java.lang.String, com.tencent.cos.xml.model.tag.COSMetaData)
:bucketName包含appid,比如:test-1250000000
bucketName
- bucket 名称, 如 testobjectName
- 对象在 COS 上的路径,比如 image/me.pngmetaData
- 对象元数据CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常@Deprecated void updateObjectMetaAsync(java.lang.String bucketName, java.lang.String objectName, COSMetaData metaData, CosXmlBooleanListener booleanListener)
更新对象元数据的异步方法。 建议使用updateObjectMetaDataAsync(java.lang.String, java.lang.String, com.tencent.cos.xml.model.tag.COSMetaData, com.tencent.cos.xml.listener.CosXmlBooleanListener)
updateObjectMetaAsync(java.lang.String, java.lang.String, com.tencent.cos.xml.model.tag.COSMetaData, com.tencent.cos.xml.listener.CosXmlBooleanListener)
:bucketName不含appid,比如:test
updateObjectMetaDataAsync(java.lang.String, java.lang.String, com.tencent.cos.xml.model.tag.COSMetaData, com.tencent.cos.xml.listener.CosXmlBooleanListener)
:bucketName包含appid,比如:test-1250000000
基于 SimpleCosXml.copyObjectAsync(CopyObjectRequest, CosXmlResultListener)
实现
bucketName
- bucket 名称, 如 testobjectName
- 对象在 COS 上的路径,比如 image/me.pngmetaData
- 对象元数据booleanListener
- 结果回调函数boolean updateObjectMetaData(java.lang.String bucketName, java.lang.String objectName, COSMetaData metaData) throws CosXmlClientException, CosXmlServiceException
更新对象元数据的同步方法。
bucketName
- bucket 名称, 如 test-1250000000objectName
- 对象在 COS 上的路径,比如 image/me.pngmetaData
- 对象元数据CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void updateObjectMetaDataAsync(java.lang.String bucketName, java.lang.String objectName, COSMetaData metaData, CosXmlBooleanListener booleanListener)
更新对象元数据的异步方法。
基于 SimpleCosXml.copyObjectAsync(CopyObjectRequest, CosXmlResultListener)
实现
bucketName
- bucket 名称, 如 test-1250000000objectName
- 对象在 COS 上的路径,比如 image/me.pngmetaData
- 对象元数据booleanListener
- 结果回调函数GetPrivateM3U8Result getPrivateM3U8(GetPrivateM3U8Request request) throws CosXmlClientException, CosXmlServiceException
GetPrivateM3U8 接口用于获取私有 M3U8 ts 资源的下载授权。(此方式通过对象存储转发请求至数据万象)的同步方法.
API 接口:https://cloud.tencent.com/document/product/436/63740request
- GetPrivateM3U8 接口用于获取私有 M3U8 ts 资源的下载授权。(此方式通过对象存储转发请求至数据万象)请求 GetPrivateM3U8Request
GetPrivateM3U8Result
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getPrivateM3U8Async(GetPrivateM3U8Request request, CosXmlResultListener cosXmlResultListener)
GetPrivateM3U8 接口用于获取私有 M3U8 ts 资源的下载授权。(此方式通过对象存储转发请求至数据万象)的异步方法.
request
- GetPrivateM3U8 接口用于获取私有 M3U8 ts 资源的下载授权。(此方式通过对象存储转发请求至数据万象)请求 GetPrivateM3U8Request
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
GetWorkflowDetailResult getWorkflowDetail(GetWorkflowDetailRequest request) throws CosXmlClientException, CosXmlServiceException
获取工作流实例详情的同步方法.
API 接口:https://cloud.tencent.com/document/product/460/80044request
- 获取工作流实例详情请求 GetWorkflowDetailRequest
GetWorkflowDetailResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void getWorkflowDetailAsync(GetWorkflowDetailRequest request, CosXmlResultListener cosXmlResultListener)
获取工作流实例详情的异步方法.
request
- 获取工作流实例详情请求 GetWorkflowDetailRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener