public interface IObsClient
void refresh(String accessKey, String secretKey, String securityToken)
accessKey - 临时访问密钥中的AKsecretKey - 临时访问密钥中的SKsecurityToken - 安全令牌TemporarySignatureResponse createTemporarySignature(TemporarySignatureRequest request)
request - 临时授权访问的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常PostSignatureResponse createPostSignature(PostSignatureRequest request) throws ObsException
request - 基于V4的浏览器表单授权访问请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsBucket createBucket(String bucketName) throws ObsException
桶命名规范:
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsBucket createBucket(String bucketName, String location) throws ObsException
桶命名规范:
bucketName - 桶名location - 创建桶的区域, 如果使用的终端节点归属于默认区域,可以不携带此参数;如果使用的终端节点归属于其他区域,则必须携带此参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsBucket createBucket(ObsBucket bucket) throws ObsException
桶命名规范:
bucket - 桶信息,包含请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsBucket createBucket(CreateBucketRequest request) throws ObsException
桶命名规范:
request - 创建桶请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常List<ObsBucket> listBuckets(ListBucketsRequest request) throws ObsException
request - 获取桶列表请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ListBucketsResult listBucketsV2(ListBucketsRequest request) throws ObsException
request - 获取桶列表请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucket(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObjectListing listObjects(ListObjectsRequest request) throws ObsException
request - 列举桶内对象请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObjectListing listObjects(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常boolean headBucket(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ListVersionsResult listVersions(ListVersionsRequest request) throws ObsException
request - 列举桶内多版本对象请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ListVersionsResult listVersions(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ListVersionsResult listVersions(String bucketName, long maxKeys) throws ObsException
bucketName - 桶名maxKeys - 列举多版本对象的最大条目数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ListVersionsResult listVersions(String bucketName, String prefix, String delimiter, String keyMarker, String versionIdMarker, long maxKeys) throws ObsException
bucketName - 桶名prefix - 列举多版本对象时的对象名前缀delimiter - 对象名进行分组的字符keyMarker - 列举多版本对象的起始位置(按对象名排序)versionIdMarker - 列举多版本对象的起始位置(按对象版本号排序)maxKeys - 列举多版本对象的最大条目数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketMetadataInfoResult getBucketMetadata(BucketMetadataInfoRequest request) throws ObsException
request - 获取桶元数据的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常AccessControlList getBucketAcl(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketAcl(String bucketName, AccessControlList acl) throws ObsException
bucketName - 桶名acl - 访问权限ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常String getBucketLocation(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketLocationResponse getBucketLocationV2(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketStorageInfo getBucketStorageInfo(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketQuota getBucketQuota(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketQuota(String bucketName, BucketQuota bucketQuota) throws ObsException
bucketName - 桶名bucketQuota - 桶配额ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketStoragePolicyConfiguration getBucketStoragePolicy(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage) throws ObsException
bucketName - 桶名bucketStorage - 桶的存储策略ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketCors(String bucketName, BucketCors bucketCors) throws ObsException
bucketName - 桶名bucketCors - CORS配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketCors getBucketCors(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketCors(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketLoggingConfiguration getBucketLogging(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketLoggingConfiguration(String bucketName, BucketLoggingConfiguration loggingConfiguration, boolean updateTargetACLifRequired) throws ObsException
ObsExceptionHeaderResponse setBucketLogging(String bucketName, BucketLoggingConfiguration loggingConfiguration) throws ObsException
bucketName - 桶名loggingConfiguration - 日志管理配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketVersioning(String bucketName, BucketVersioningConfiguration versioningConfiguration) throws ObsException
bucketName - 桶名versioningConfiguration - 桶的多版本状态配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketVersioningConfiguration getBucketVersioning(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常LifecycleConfiguration getBucketLifecycle(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketLifecycle(String bucketName, LifecycleConfiguration lifecycleConfig) throws ObsException
bucketName - 桶名lifecycleConfig - 桶的生命周期配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketLifecycle(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常String getBucketPolicy(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketPolicyResponse getBucketPolicyV2(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketPolicy(String bucketName, String policy) throws ObsException
bucketName - 桶名policy - 桶策略,JSON格式字符串ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketPolicy(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常WebsiteConfiguration getBucketWebsite(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketWebsite(String bucketName, WebsiteConfiguration websiteConfig) throws ObsException
bucketName - 桶名websiteConfig - 桶的website(托管)配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketWebsite(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketTagInfo getBucketTagging(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketTagging(String bucketName, BucketTagInfo bucketTagInfo) throws ObsException
bucketName - 桶名bucketTagInfo - 桶标签ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketTagging(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketEncryption getBucketEncryption(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketEncryption(String bucketName, BucketEncryption bucketEncryption) throws ObsException
bucketName - 桶名bucketEncryption - 桶加密配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketEncryption(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketReplication(String bucketName, ReplicationConfiguration replicationConfiguration) throws ObsException
bucketName - 桶名replicationConfiguration - 跨Region复制配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ReplicationConfiguration getBucketReplication(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketReplication(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketNotificationConfiguration getBucketNotification(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketNotification(String bucketName, BucketNotificationConfiguration bucketNotificationConfiguration) throws ObsException
bucketName - 桶名bucketNotificationConfiguration - 桶的消息通知配置ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常PutObjectResult putObject(String bucketName, String objectKey, InputStream input, ObjectMetadata metadata) throws ObsException
bucketName - 桶名objectKey - 对象名input - 待上传的数据流metadata - 对象的属性ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常PutObjectResult putObject(String bucketName, String objectKey, InputStream input) throws ObsException
bucketName - 桶名objectKey - 对象名input - 待上传的数据流ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常PutObjectResult putObject(PutObjectRequest request) throws ObsException
request - 上传对象请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常PutObjectResult putObject(String bucketName, String objectKey, File file) throws ObsException
bucketName - 桶名objectKey - 对象名file - 待上传的文件ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常PutObjectResult putObject(String bucketName, String objectKey, File file, ObjectMetadata metadata) throws ObsException
bucketName - 桶名objectKey - 对象名file - 待上传的文件metadata - 对象的属性ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常AppendObjectResult appendObject(AppendObjectRequest request) throws ObsException
request - 追加上传请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常CompleteMultipartUploadResult uploadFile(UploadFileRequest uploadFileRequest) throws ObsException
uploadFileRequest - 上传文件请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常UploadProgressStatus putObjects(PutObjectsRequest request) throws ObsException
request - 批量上传文件的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常DownloadFileResult downloadFile(DownloadFileRequest downloadFileRequest) throws ObsException
downloadFileRequest - 下载文件的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsObject getObject(GetObjectRequest request) throws ObsException
request - 下载对象的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsObject getObject(String bucketName, String objectKey, String versionId) throws ObsException
bucketName - 桶名objectKey - 对象名versionId - 对象版本号ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObsObject getObject(String bucketName, String objectKey) throws ObsException
bucketName - 桶名objectKey - 对象名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObjectMetadata getObjectMetadata(GetObjectMetadataRequest request) throws ObsException
request - 获取对象属性的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObjectMetadata getObjectMetadata(String bucketName, String objectKey, String versionId) throws ObsException
bucketName - 桶名objectKey - 对象名versionId - 对象版本号ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObjectMetadata getObjectMetadata(String bucketName, String objectKey) throws ObsException
bucketName - 桶名objectKey - 对象名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ObjectMetadata setObjectMetadata(SetObjectMetadataRequest request) throws ObsException
request - 设置对象属性的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常@Deprecated RestoreObjectRequest.RestoreObjectStatus restoreObject(RestoreObjectRequest request) throws ObsException
request - 取回归档存储对象的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常RestoreObjectResult restoreObjectV2(RestoreObjectRequest request) throws ObsException
request - 取回归档存储对象的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常TaskProgressStatus restoreObjects(RestoreObjectsRequest request) throws ObsException
request - 批量取回归档存储对象的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常DeleteObjectResult deleteObject(String bucketName, String objectKey, String versionId) throws ObsException
bucketName - 桶名objectKey - 对象名versionId - 对象版本号ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常DeleteObjectResult deleteObject(String bucketName, String objectKey) throws ObsException
bucketName - 桶名objectKey - 对象名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest) throws ObsException
deleteObjectsRequest - 批量删除对象的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常AccessControlList getObjectAcl(String bucketName, String objectKey, String versionId) throws ObsException
bucketName - 桶名objectKey - 对象名versionId - 对象版本号ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常AccessControlList getObjectAcl(String bucketName, String objectKey) throws ObsException
bucketName - 桶名objectKey - 对象名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setObjectAcl(String bucketName, String objectKey, AccessControlList acl, String versionId) throws ObsException
bucketName - 桶名objectKey - 对象名acl - 访问权限versionId - 对象版本号ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setObjectAcl(String bucketName, String objectKey, AccessControlList acl) throws ObsException
bucketName - 桶名objectKey - 对象名acl - 访问权限ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常CopyObjectResult copyObject(CopyObjectRequest request) throws ObsException
request - 复制对象请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常CopyObjectResult copyObject(String sourceBucketName, String sourceObjectKey, String destBucketName, String destObjectKey) throws ObsException
sourceBucketName - 源桶名sourceObjectKey - 源对象名destBucketName - 目标桶名destObjectKey - 目标对象名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request) throws ObsException
request - 初始化分段上传任务的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse abortMultipartUpload(AbortMultipartUploadRequest request) throws ObsException
request - 取消分段上传任务的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常UploadPartResult uploadPart(String bucketName, String objectKey, String uploadId, int partNumber, InputStream input) throws ObsException
bucketName - 桶名objectKey - 对象名uploadId - 分段上传任务的ID号partNumber - 分段号input - 待上传的数据流ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常UploadPartResult uploadPart(String bucketName, String objectKey, String uploadId, int partNumber, File file) throws ObsException
bucketName - 桶名objectKey - 对象名uploadId - 分段上传任务的ID号partNumber - 分段号file - 待上传的文件ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常UploadPartResult uploadPart(UploadPartRequest request) throws ObsException
request - 上传段的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常CopyPartResult copyPart(CopyPartRequest request) throws ObsException
request - 复制段的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request) throws ObsException
request - 合并段的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ListPartsResult listParts(ListPartsRequest request) throws ObsException
request - 列举已上传段的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request) throws ObsException
request - 列举分段上传任务的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ReadAheadResult readAheadObjects(ReadAheadRequest request) throws ObsException
request - 预读对象的请求参数ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ReadAheadResult deleteReadAheadObjects(String bucketName, String prefix) throws ObsException
bucketName - 桶名prefix - 预读对象的对象名前缀ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常ReadAheadQueryResult queryReadAheadObjectsTask(String bucketName, String taskId) throws ObsException
bucketName - 桶名taskId - 预读任务IDObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse setBucketDirectColdAccess(String bucketName, BucketDirectColdAccess access) throws ObsException
bucketName - 桶名access - 直读策略ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常BucketDirectColdAccess getBucketDirectColdAccess(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常HeaderResponse deleteBucketDirectColdAccess(String bucketName) throws ObsException
bucketName - 桶名ObsException - OBS SDK自定义异常,当调用接口失败、访问OBS失败时抛出该异常void close()
throws IOException
IOException - 客户端关闭异常Copyright © 2019. All rights reserved.