华为云用户手册

自定义设置对象ACL 以下代码展示如何直接设置对象ACL： // 初始化配置参数 ObsConfig config = new ObsConfig(); config.Endpoint = "https://your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html string accessKey= Environment.GetEnvironmentVariable("AccessKeyID", EnvironmentVariableTarget.Machine); string secretKey= Environment.GetEnvironmentVariable("SecretAccessKey", EnvironmentVariableTarget.Machine); // 创建ObsClient实例 ObsClient client = new ObsClient(accessKey, secretKey, config); // 自定义设置对象ACL try { SetObjectAclRequest request = new SetObjectAclRequest(); request.BucketName = "bucketname"; request.ObjectKey = "objectname"; request.AccessControlList = new AccessControlList(); Owner owner = new Owner(); owner.Id = "owerid"; request.AccessControlList.Owner = owner; Grant item = new Grant(); item.Permission = PermissionEnum.FullControl; item.Grantee = new GroupGrantee(GroupGranteeEnum.AllUsers); request.AccessControlList.Grants.Add(item); SetObjectAclResponse response = client.SetObjectAcl(request); Console.WriteLine("Set object acl response: {0}", response.StatusCode); } catch (ObsException ex) { Console.WriteLine("ErrorCode: {0}", ex.ErrorCode); Console.WriteLine("ErrorMessage: {0}", ex.ErrorMessage); } ACL中需要填写的所有者（Owner）或者被授权用户（Grantee）的ID，是指用户的账号ID，可通过OBS控制台“我的凭证”页面查看。

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

限定条件复制 复制对象时，可以指定一个或多个限定条件，满足限定条件时则进行复制，否则返回异常码，复制对象失败。 您可以使用的限定条件如下： 参数 作用 格式 CopySourceIfModifiedSince 如果源对象在指定的时间后有修改，则进行复制，否则抛出异常。 符合http://www.ietf.org/rfc/rfc2616.txt规定格式的HTTP时间字符串。 CopySourceIfUnmodifiedSince 如果源对象在指定的时间后没有修改，则进行复制，否则抛出异常。 符合http://www.ietf.org/rfc/rfc2616.txt规定格式的HTTP时间字符串。 CopySourceIfMatch 如果源对象的ETag值与该参数值相同，则进行复制，否则返回异常码。 字符串。 CopySourceIfNoneMatch 如果源对象的ETag值与该参数值不相同，则进行复制，否则返回异常码。 字符串。

代码示例：带参数创建 创建桶时可以指定对象ACL、存储类别和区域位置。示例代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.AccessControlList; import com.obs.services.model.AvailableZoneEnum; import com.obs.services.model.CreateBucketRequest; import com.obs.services.model.ObsBucket; import com.obs.services.model.StorageClassEnum; public class CreateBucket001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("AC CES S_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { CreateBucketRequest request = new CreateBucketRequest(); //示例桶名 String exampleBucket = "examplebucket"; //示例桶区域位置 String exampleLocation = "cn-north-4"; request.setBucketName(exampleBucket); // 设置桶ACL为私有读写，默认也是私有读写 request.setAcl(AccessControlList.REST_CANNED_PRIVATE); // 设置桶的存储类别为标准存储 request.setBucketStorageClass(StorageClassEnum.STANDARD); // 设置桶区域位置(以区域为华北-北京四为例)，location 需要与 endpoint的位置信息一致 request.setLocation(exampleLocation); // 指定创建多AZ桶，如果不设置，默认创建单AZ桶 request.setAvailableZone(AvailableZoneEnum.MULTI_AZ); // 创建桶 ObsBucket bucket = obsClient.createBucket(request); // 创建桶成功 System.out.println("CreateBucket successfully"); System.out.println("RequestId:"+bucket.getRequestId()); } catch (ObsException e) { System.out.println("CreateBucket failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code: " + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message: " + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); } catch (Exception e) { System.out.println("CreateBucket failed"); // 其他异常信息打印 e.printStackTrace(); } } }

接口约束 您必须拥有obs:bucket:CreateBucket权限，才能创建桶。建议使用 IAM 进行授权，配置方式详见使用IAM自定义策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 创建桶时，如果初始化客户端使用的终端节点（endPoint）为“obs.myhuaweicloud.com”，则可以不指定桶所在区域（location），系统会自动在华北-北京一（cn-north-1）创建桶；如果初始化客户端使用的终端节点（endPoint）不是obs.myhuaweicloud.com，则必须指定桶所在区域（location），且指定的区域必须与终端节点（endPoint）区域一致，否则会返回状态码400。 比如初始化时使用的终端节点endPoint是obs.cn-north-4.myhuaweicloud.com，那么在创建桶的时候必须指定Location：cn-north-4才会创建成功。 同一账号下，可以创建多个桶，数量上限是100个（包括对象桶和并行文件系统，不区分地域），存储桶中的对象数量和大小没有限制。 新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409，表明桶已存在。 用户删除桶后，需要等待30分钟才能创建同名桶和并行文件系统。 并不是所有区域都支持创建多AZ桶，您可以在产品价格详情页面，查询指定区域是否支持多AZ。

方法定义 方法1：按照用户指定的桶名创建一个新桶 createBucket(String bucketName) 方法2：按照用户指定的桶名和指定的区域创建一个新桶 createBucket(String bucketName, String location) 方法3：按照用户指定的桶名和指定的区域创建一个新桶 createBucket(ObsBucket bucket) 方法4：创建桶, 支持设置访问权限、存储类别、区域位置、集群类型、桶类型（对象桶或并行文件系统）、企业ID、桶扩展权限 createBucket(CreateBucketRequest request)

代码示例：简单创建 以下代码展示如何新建一个桶，仅设置桶名和endPoint。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.ObsBucket; public class CreateBucket002 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 示例桶名 String exampleBucket = "examplebucket"; // 创建桶 ObsBucket bucket = obsClient.createBucket(exampleBucket); System.out.println("CreateBucket successfully"); System.out.println("StatusCode: " + bucket.getStatusCode()); System.out.println("RequestId: " + bucket.getRequestId()); } catch (ObsException e) { System.out.println("CreateBucket failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code: " + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message: " + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); } catch (Exception e) { System.out.println("CreateBucket failed"); // 其他异常信息打印 e.printStackTrace(); } } }

功能说明 OBS客户端支持通过访问密钥、请求方法类型、请求参数等信息生成一个在Query参数中携带鉴权信息的URL，可将该URL提供给其他用户进行临时访问。在生成URL时，您需要指定URL的有效期来限制访客用户的访问时长。 如果您想授予其他用户对桶或对象临时进行其他操作的权限（例如上传或下载对象），则需要生成带对应请求的URL后（例如使用生成PUT请求的URL上传对象），将该URL提供给其他用户。 如果遇到跨域报错、签名不匹配问题，请参考以下步骤排查问题： 未配置跨域，需要在控制台配置CORS规则，请参考配置桶允许跨域请求。 签名计算问题，请参考URL中携带签名排查签名参数是否正确；比如上传对象功能，后端将Content-Type参与计算签名生成授权URL，但是前端使用授权URL时没有设置Content-Type字段或者传入错误的值，此时会出现跨域错误。解决方案为：Content-Type字段前后端保持一致。 不支持通过 CDN加速 后的 域名 生成临时访问URL。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 HTML表单中的policy，signature的值均是从ObsClient.createPostSignature的返回结果中获取。 上传对象 contentType字段需要手动修改为对应的Content-Type值。 在设置对象ACL权限时，HTML表单中的acl取值参见 OBS预定义的权限控制策略。 您可以直接下载表单HTML示例PostDemo。

功能说明 基于表单上传是使用HTML表单形式上传对象到指定桶中，对象最大不能超过5GB。 您可以通过ObsClient.createPostSignature生成基于表单上传的请求参数。使用代码模拟表单上传的完整代码示例，参见PostObjectSample。您也可以通过如下步骤进行表单上传： 使用ObsClient.createPostSignature生成用于鉴权的请求参数。 准备表单HTML页面。 将生成的请求参数填入HTML页面。 选择本地文件，进行表单上传。 使用SDK生成的用于鉴权的请求参数包括两个： Policy，对应表单中policy字段。 Signature，对应表单中的signature字段。

返回结果说明 表3 PostSignatureResponse 参数名称 参数类型 描述 OriginPolicy String 参数解释： Policy未经过Base64之前的值，仅用于校验。示例如下： {"expiration":"2023-09-12T12:52:59Z","conditions":[{"content-type":"text/plain"},{"bucket":"examplebucket"},{"key":"example/objectname"},]}" 默认取值： 无 Policy String 参数解释： 表单中的policy，已经Base64之后的值。示例如下： eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0xMlQxMjo1Mjo1OVoiLCJjb25kaXRpb25zIjpbeyJjb250ZW50LXR5cGUiOiJ0ZXh0L3BsYWluIn0seyJidWNrZXQiOiJleGFtcGxlYnVja2V0In0seyJrZXkiOiJleGFtcGxlL29iamVjdG5hbWUifSxdfQ== 默认取值： 无 Signature String 参数解释： 表单中的signature。示例如下： g0jQr4v9VWd1Q2FOFDG6LGfV9Cw= 默认取值： 无

代码示例 以下代码展示了examplebucket桶如何实现网站文件托管：（1）上传对象时，设置对象的MIME类型；（2）设置对象ACL为公共读。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.AccessControlList; import com.obs.services.model.ObjectMetadata; import com.obs.services.model.PutObjectRequest; import java.io.File; public class PutObject001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 以下代码展示了如何实现网站文件托管 // 上传对象，设置对象MIME类型 PutObjectRequest request = new PutObjectRequest(); request.setBucketName("examplebucket"); request.setObjectKey("test.html"); request.setFile(new File("localfile.html")); ObjectMetadata metadata = new ObjectMetadata(); metadata.setContentType("text/html"); request.setMetadata(metadata); obsClient.putObject(request); // 设置对象ACL为公共读 obsClient.setObjectAcl("examplebucket", "test.html", AccessControlList.REST_CANNED_PUBLIC_READ); System.out.println("putObject successfully"); } catch (ObsException e) { System.out.println("putObject failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("putObject failed"); // 其他异常信息打印 e.printStackTrace(); } } } 上例中您可以使用https://bucketname.your-endpoint/test.html在浏览器直接访问托管的文件。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 您必须是桶拥有者或拥有设置桶ACL的权限，才能设置桶ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketAcl权限，如果使用桶策略则需授予PutBucketAcl权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。

设置对象ACL请求参数说明 表22 请求参数列表 参数名称 参数类型 是否必选 描述 request SetObjectAclRequest 必选 参数解释： 设置对象ACL请求参数，详见SetObjectAclRequest。 表23 SetObjectAclRequest 参数名称 参数类型 是否必选 描述 bucketName String 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey String 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 versionId String 可选 参数解释： 对象的版本号。 取值范围： 长度为32的字符串。 默认取值： 无 acl AccessControlList 可选 参数解释： 指定对象的ACL，您可以使用预定义的ACL，也可以自定义ACL，有关访问控制列表（Access Control List，ACL）功能的详细信息可参见ACL功能介绍。 取值范围： 如果使用预定义ACL，则可选配置项参见ACL预定义访问策略。 如果选择自定义ACL，则可以根据AccessControlList参数描述，自行给参数赋值。 默认取值： AccessControlList.REST_CANNED_PRIVATE

代码示例：简单复制对象 本示例展示了如何将sourcebucketname桶下的sourceobjectname对象简单复制到destbucketname桶下的destobjectname对象中。示例代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.CopyObjectResult; public class CopyObject001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 简单复制 CopyObjectResult result = obsClient.copyObject("sourcebucketname", "sourceobjectname", "destbucketname", "destobjectname"); System.out.println("copyObject successfully"); System.out.println("StatusCode:" + result.getStatusCode()); System.out.println("Etag:" + result.getEtag()); } catch (ObsException e) { System.out.println("copyObject failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("copyObject failed"); // 其他异常信息打印 e.printStackTrace(); } } }

代码示例：限定条件复制 限定条件复制。将sourcebucketname桶下的sourceobjectname对象复制到destbucketname桶下的destobjectname对象中。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.CopyObjectRequest; import com.obs.services.model.CopyObjectResult; import java.text.SimpleDateFormat; public class CopyObject003 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 限定条件复制 CopyObjectRequest request = new CopyObjectRequest("sourcebucketname", "sourceobjectname", "destbucketname", "destobjectname"); request.setIfModifiedSince(new SimpleDateFormat("yyyy-MM-dd").parse("2016-01-01")); request.setIfNoneMatchTag("none-match-etag"); CopyObjectResult result = obsClient.copyObject(request); System.out.println("copyObject successfully"); System.out.println("Etag:" + result.getEtag()); } catch (ObsException e) { System.out.println("copyObject failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("copyObject failed"); // 其他异常信息打印 e.printStackTrace(); } } }

接口约束 您必须是桶拥有者或拥有复制对象的权限，才能复制对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 用户有待复制的源对象的读权限。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 复制对象操作的请求需要通过头域携带拷贝的源桶和对象信息，不能携带消息实体。 支持同区域跨桶复制，不支持跨区域复制。 目标对象大小范围是[0, 5GB]，如果源对象大小超过5GB，只能使用分段复制功能复制对象。 如果待复制的源对象是归档或深度归档存储类别，则必须先恢复源对象才能进行复制。

代码示例：复制对象时重写对象ACL 复制对象时重写对象ACL，将sourcebucketname桶下的sourceobjectname对象复制到destbucketname桶下的destobjectname对象中。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.AccessControlList; import com.obs.services.model.CopyObjectRequest; import com.obs.services.model.CopyObjectResult; public class CopyObject004 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 复制对象时重写对象ACL CopyObjectRequest request = new CopyObjectRequest("sourcebucketname", "sourceobjectname", "destbucketname", "destobjectname"); // 复制时重写对象ACL为私有读写 request.setAcl(AccessControlList.REST_CANNED_PRIVATE); CopyObjectResult result = obsClient.copyObject(request); System.out.println("copyObject successfully"); System.out.println("Etag:" + result.getEtag()); } catch (ObsException e) { System.out.println("copyObject failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("copyObject failed"); // 其他异常信息打印 e.printStackTrace(); } } }

功能说明 OBS支持对对象的操作进行权限控制。默认情况下，只有对象的创建者才有该对象的读写权限。用户也可以设置其他的访问策略，比如对一个对象可以设置公共访问策略，允许所有人对其都有读权限。SSE-KMS方式加密的对象即使设置了ACL，跨租户也不生效。 OBS用户在上传对象时可以设置权限控制策略，也可以通过ACL操作API接口对已存在的对象更改或者获取ACL(access control list) 。 开发过程中，您有任何问题可以在github上提交issue，或者在华为云 对象存储服务 论坛中发帖求助。

接口约束 您必须是桶拥有者或拥有设置对象ACL的权限，才能设置对象ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObjectAcl权限，如果使用桶策略则需授予PutObjectAcl权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 一个对象的ACL最多支持100条Grant授权。

代码示例 本示例用于为examplebucket桶中objectname对象设置多版本对象ACL。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.AccessControlList; import com.obs.services.model.GroupGrantee; import com.obs.services.model.Owner; import com.obs.services.model.Permission; public class SetObjectAcl001 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 通过预定义访问策略设置多版本对象ACL为私有读写 obsClient.setObjectAcl("examplebucket", "objectname", AccessControlList.REST_CANNED_PRIVATE, "versionid"); AccessControlList acl = new AccessControlList(); Owner owner = new Owner(); owner.setId("ownerid"); acl.setOwner(owner); // 为所有用户设置读权限 acl.grantPermission(GroupGrantee.ALL_USERS, Permission.PERMISSION_READ); // 设置多版本对象ACL obsClient.setObjectAcl("examplebucket", "objectname", acl, "versionid"); System.out.println("setObjectAcl successfully"); } catch (ObsException e) { System.out.println("setObjectAcl failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("setObjectAcl failed"); // 其他异常信息打印 e.printStackTrace(); } } } ACL中需要填写的所有者（Owner）或者被授权用户（Grantee）的ID，是指用户的账号ID，可通过OBS控制台“我的凭证”页面查看。

静态网站托管相关接口 静态网站托管相关接口如下表所示。 表9 静态网站托管相关接口概览 接口名 方法 功能描述 示例代码源代码 网站文件托管 obsClient.putObject(PutObjectRequest request) obsClient.setObjectAcl(SetObjectAclRequest acl) 将静态网站文件上传至OBS的桶中作为对象，并对这些对象赋予公共读权限，然后将该桶配置成静态网站托管模式，以实现在OBS上托管静态网站的目的。 - 设置托管配置 obsClient.setBucketWebsite(final SetBucketWebsiteRequest request) 为指定桶设置网站配置信息。 BucketOperationsSample 获取托管配置 obsClient.getBucketWebsite(final BaseBucketRequest request) 获取指定桶的网站配置信息。 BucketOperationsSample 删除托管配置 obsClient.deleteBucketWebsite(final BaseBucketRequest request) 删除指定桶的网站配置。 BucketOperationsSample

标签管理相关接口 标签管理相关接口如下表所示。 表10 标签管理相关接口概览 接口名 方法 功能描述 示例代码源代码 设置桶标签 obsClient.setBucketTagging(final SetBucketTaggingRequest request) 为桶添加标签，该桶上所有请求产生的计费话单里都会带上这些标签，从而可以针对话单报表做分类筛选，进行更详细的成本分析。 BucketOperationsSample 获取桶标签 obsClient.getBucketTagging(final BaseBucketRequest request) 获取指定桶的标签。 BucketOperationsSample 删除桶标签 obsClient.deleteBucketTagging(final BaseBucketRequest request) 删除指定桶的标签。 BucketOperationsSample

桶日志相关接口 设置访问日志相关接口如下表所示。 表8 桶日志相关接口概览 接口名 方法 功能描述 示例代码源代码 设置桶日志规则 obsClient.setBucketLogging(final SetBucketLoggingRequest request) 为指定桶打开桶日志功能，并配置日志存放的目标桶。桶日志功能开启后，桶的每次操作将会产生一条日志，并将多条日志打包成一个日志文件。日志文件存放到开启日志功能的桶中，也可以存放到其他您有权限的桶中，但需要和开启日志功能的桶在同一个region中。您还可以根据需要配置日志文件的访问权限，以及日志文件的文件名前缀。 BucketOperationsSample 获取桶日志规则 obsClient.getBucketLogging(final BaseBucketRequest request) 获取指定桶的日志配置。 BucketOperationsSample

生命周期管理相关接口 生命周期管理相关接口如下表所示。 表6 生命周期管理相关接口概览 接口名 方法 功能描述 示例代码源代码 设置生命周期规则 obsClient.setBucketLifecycle(final SetBucketLifecycleRequest request) 为指定桶设置生命周期规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用。 BucketOperationsSample 获取生命周期规则 obsClient.getBucketLifecycle(final BaseBucketRequest request) 获取指定桶的生命周期规则。 BucketOperationsSample 删除生命周期规则 obsClient.deleteBucketLifecycle(final BaseBucketRequest request) 删除指定桶的生命周期规则。 BucketOperationsSample

临时授权访问相关接口 临时授权访问相关接口如下表所示。 表4 临时授权访问相关接口概览 接口名 方法 功能描述 示例代码源代码 通过临时URL访问OBS obsClient.createTemporarySignature(TemporarySignatureRequest request) 通过访问密钥、请求方法类型、请求参数等信息生成一个在Query参数中携带鉴权信息的URL，可将该URL提供给其他用户进行临时访问。在生成URL时，您需要指定URL的有效期来限制访客用户的访问时长。 如果您想授予其他用户对桶或对象临时进行其他操作的权限（例如上传或下载对象），则需要生成带对应请求的URL后（例如使用生成PUT请求的URL上传对象），将该URL提供给其他用户。 TemporarySignatureSample

跨域资源共享相关接口 跨域资源共享相关接口如下表所示。 表7 跨域资源共享相关接口概览 接口名 方法 功能描述 示例代码源代码 设置跨域资源共享规则 obsclient.setBucketCors(final SetBucketCorsRequest request) 设置桶的跨域资源共享规则，允许客户端浏览器进行跨域请求。设置成功后，如果原规则存在则覆盖原规则。 BucketOperationsSample 获取跨域资源共享规则 obsclient.getBucketCors(final BaseBucketRequest request) 获取指定桶的跨域资源共享规则。 BucketOperationsSample 删除跨域规则 obsclient.deleteBucketCors(final BaseBucketRequest request) 删除指定桶的跨域资源共享规则。 BucketOperationsSample

多版本控制相关接口 多版本控制相关接口如下表所示。 表5 多版本控制相关接口概览 接口名 方法 功能描述 示例代码源代码 设置桶多版本状态 obsClient.setBucketVersioning(final SetBucketVersioningRequest request) 为指定桶设置多版本状态。在一个桶中保留对象的多个版本，可方便地检索和还原各个版本，在意外操作或应用程序故障时快速恢复数据。 BucketOperationsSample 获取桶多版本状态 obsClient.getBucketVersioning(final BaseBucketRequest request) 获取指定桶的多版本状态。 BucketOperationsSample 获取多版本对象 obsClient.getObject(GetObjectRequest request) 获取指定多版本对象。 - 复制多版本对象 obsClient.copyObject(CopyObjectRequest request) 为指定桶中的多版本对象创建一个副本。在单次操作中，可以创建最大5GB的对象副本。 - 恢复多版本归档存储对象 obsClient.restoreObject(RestoreObjectRequest request) 通过接口传入版本号，恢复多版本归档存储对象。 如果要下载归档存储对象，需要先将归档存储对象恢复。恢复归档存储对象的恢复选项可支持标准恢复、快速恢复。 - 列举多版本对象 obsClient.listVersions(ListVersionsRequest request) 列举指定桶内的部分或所有多版本对象的描述信息。还可以通过设置前缀、数量、起始位置等参数，返回符合您筛选条件的多版本对象信息。返回结果以多版本对象名的字典序排序。 ListVersionsSample 设置多版本对象权限 obsClient.setObjectAcl(SetObjectAclRequest request) 在上传多版本对象时，设置权限控制策略，也可以通过ACL操作API接口对已存在的对象更改或者获取ACL。 - 获取多版本对象权限 obsClient.getObjectAcl(GetObjectAclRequest request) 获取指定桶的获取多版本对象权限。 - 删除多版本对象 obsClient.deleteObject(DeleteObjectRequest request) 根据需要删除指定桶中的多版本对象，节省空间和成本。 - 批量删除多版本对象 obsClient.deleteObjects(DeleteObjectsRequest deleteRequest) 根据需要批量删除指定桶中的多个多版本对象，节省空间和成本。 批量删除对象用于将一个桶内的部分多版本对象一次性删除，删除后不可恢复。批量删除多版本对象要求返回结果里包含每个多版本对象的删除结果。 ListVersionsSample

对象相关接口 对象相关接口如下表所示。 表3 对象相关接口概览 接口名 方法 功能描述 示例代码源代码 流式上传 obsClient.putObject(PutObjectRequest request) 通过流式上传方式将本地文件上传至OBS指定的位置，支持上传小于5GB的文件。待上传的文件可以是任何类型：文本文件、图片、视频等。 ObjectOperationsSample 文件上传 obsClient.putObject(PutObjectRequest request) 将本地文件直接通过Internet上传至OBS指定的桶中。待上传的文件可以是任何类型：文本文件、图片、视频等。 - 获取上传进度 PutObjectRequest.setProgressListener(ProgressListener progressListener) 获取指定对象的上传进度。 - 创建文件夹 obsClient.putObject(PutObjectRequest request) 在已创建的桶中新建一个文件夹，从而更方便的对存储在OBS中的数据进行分类管理。 CreateFolderSample 设置对象元数据 obsClient.setObjectMetadata(SetObjectMetadataRequest request) 在上传对象时设置对象属性。对象属性包含对象长度、对象MIME类型、对象MD5值（用于校验）、对象存储类别、对象自定义元数据。对象属性可以在多种上传方式下（流式上传、文件上传、分段上传），或复制对象时进行设置。 ObjectMetaSample 初始化分段上传任务 obsClient.initiateMultipartUpload(InitiateMultipartUploadRequest request) 使用分段上传方式传输数据前，必须先通知OBS初始化一个分段上传任务。该操作会返回一个OBS服务端创建的全局唯一标识（Upload ID），用于标识本次分段上传任务。 SimpleMultipartUploadSample 上传段 obsClient.uploadPart(UploadPartRequest request) 初始化分段上传任务后，通过分段上传任务的ID，上传段到指定桶中。 SimpleMultipartUploadSample 合并段 obsClient.completeMultipartUpload(CompleteMultipartUploadRequest request) 通过分段上传任务的ID和对应已上传的段信息（包括PartNumber和ETag），合并成一个完整的对象。 SimpleMultipartUploadSample 取消分段上传任务 obsClient.abortMultipartUpload(AbortMultipartUploadRequest request) 通过分段上传任务的ID，取消指定桶中的分段上传任务。 - 列举已上传的段 obsClient.listParts(ListPartsRequest request) 通过分段上传任务的ID，列举指定桶中已上传的段。 ConcurrentUploadPartSample 列举分段上传任务 obsClient.listMultipartUploads(ListMultipartUploadsRequest request) 列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。 - 设置对象生命周期 obsClient.putObject(PutObjectRequest request) OBS支持用户配置指定的规则，实现定时删除桶中的对象或者定时转换对象的存储类别，从而节省存储费用。此接口设置的对象过期时间，其优先级高于桶生命周期规则。 - 追加上传 obsClient.appendObject(AppendObjectRequest request) 对同一个对象追加数据内容。 - 断点续传上传 obsClient.uploadFile(UploadFileRequest request) 对分段上传的封装和加强，解决上传大文件时由于网络不稳定或程序崩溃导致上传失败的问题。 - 基于表单上传 obsClient.createPostSignature(PostSignatureRequest request) 使用HTML表单形式上传对象到指定桶中，对象最大不能超过5GB。 PostObjectSample 流式下载 obsClient.getObject(GetObjectRequest request) 根据需要通过流式下载将存储在OBS中的指定对象下载到本地。接口返回的ObsObject实例包含对象所在的桶、对象名、对象属性、对象输入流等内容，同时可以通过操作对象输入流将对象的内容读取到本地文件或者内存中。 DownloadSample 范围下载 obsClient.getObject(GetObjectRequest request) 如果只需要下载对象的其中一部分数据，可以使用范围下载，下载指定范围的数据。 - 获取下载进度 GetObjectRequest.setProgressListener(ProgressListener progressListener) 获取指定对象的下载进度。 - 限定条件下载 obsClient.getObject(GetObjectRequest request) 下载对象时，可以指定一个或多个限定条件，满足限定条件时则进行下载，否则返回异常码，下载对象失败。 - 重写响应头 obsClient.getObject(GetObjectRequest request) 下载对象时，可以重写HTTP/HTTPS中部分响应头的信息：Content-Type、Content-Language、Expires、Cache-Control、Content-Disposition、Content-Encoding。 - 获取自定义元数据 obsClient.getObject(GetObjectRequest request) 本接口可以在下载对象成功后返回对象的自定义元数据。 ObjectMetaSample 恢复归档存储对象 obsClient.restoreObject(RestoreObjectRequest request) 如果要下载归档存储对象，需要先将归档存储对象恢复。恢复归档存储对象的恢复选项可支持标准恢复、快速恢复。 RestoreObjectSample 断点续传下载 obsClient.downloadFile(DownloadFileRequest request) 对范围下载的封装和加强，解决下载大对象到本地时由于网络不稳定或程序崩溃导致下载失败的问题。 - 下载对象接口实现图片处理 obsClient.getObject(GetObjectRequest request) 下载图片文件时，通过传入图片处理参数对图片文件进行图片剪切、图片缩放、图片水印、格式转换等处理。 - 临时授权方式实现图片处理 obsClient.createTemporarySignature(TemporarySignatureRequest request) 通过临时授权方式传入图片处理参数，对图片文件进行图片剪切、图片缩放、图片水印、格式转换等处理。 - 设置对象元数据 obsClient.setObjectMetadata(SetObjectMetadataRequest request) 对指定桶中的对象发送HEAD请求，设置对象的元数据信息。 - 获取对象元数据 obsClient.getObjectMetadata(GetObjectMetadataRequest request) 对指定桶中的对象发送HEAD请求，获取对象的元数据信息。 - 设置对象ACLs obsClient.setObjectAcl(SetObjectAclRequest request) 在上传对象时设置权限控制策略，也可以通过ACL操作API接口对已存在的对象更改ACL 。 ObjectOperationsSample 获取对象ACLs obsClient.getObjectAcl(GetObjectAclRequest request) 通过接口获取指定桶中对象的ACL访问权限，返回信息包含指定对象的权限控制列表信息。 ObjectOperationsSample 列举对象 obsClient.listObjects(ListObjectsRequest request) 列举指定桶内的部分或所有对象的描述信息。还可以通过设置前缀、数量、起始位置等参数，返回符合筛选条件的对象信息。返回结果以对象名的字典序排序。 ListObjectsSample 删除对象 obsClient.deleteObject(DeleteObjectRequest request) 根据需要删除指定桶中的对象，节省空间和成本。 ObjectOperationsSample 批量删除对象 obsClient.deleteObjects(DeleteObjectsRequest deleteRequest) 根据需要批量删除指定桶中的多个对象，节省空间和成本。 批量删除对象用于将一个桶内的部分对象一次性删除，删除后不可恢复。批量删除对象要求返回结果里包含每个对象的删除结果。 DeleteObjectsSample 复制对象 obsClient.copyObject(CopyObjectRequest request) 为指定桶中的对象创建一个副本。在单次操作中，可以创建最大5GB的对象副本。 ObjectOperationsSample 分段复制 obsClient.copyPart(CopyPartRequest request) 初始化分段上传任务后，通过分段上传任务的ID，复制段到指定桶中。 ConcurrentCopyPartSample 判断对象是否存在 doesObjectExist(final GetObjectMetadataRequest request) 判断对象是否存在，返回的结果中HTTP状态码为200表明对象存在，否则返回404表明对象或桶不存在。 -

并行文件系统相关接口 并行文件系统相关接口如下表所示。 表2 并行文件系统相关接口概览 接口名 方法 功能描述 示例代码源代码 创建并行文件系统 obsClient.createBucket(CreateBucketRequest request) 在当前账号按照用户指定的并行文件系统名称创建一个新并行文件系统，接口支持根据用户诉求，在创建并行文件系统的同时配置并行文件系统的区域及桶ACL等参数。 PFSBucketAndObjectOperationSample 列举并行文件系统 obsClient.listBuckets(ListBucketsRequest request) 列举当前账号下符合指定条件的并行文件系统。返回结果以文件系统名的字典序排列。 PFSBucketAndObjectOperationSample 列举并行文件系统内对象 obsClient.listObjects(final ListObjectsRequest request) 列举出指定并行文件系统里的对象。 PFSBucketAndObjectOperationSample 修改写对象 obsClient.modifyObject(ModifyObjectRequest request) 将指定并行文件系统内的一个对象从指定位置起修改为其他内容。 PFSBucketAndObjectOperationSample 重命名对象 obsClient.renameObject(RenameObjectRequest request) 重命名对象操作是指将指定并行文件系统内的一个对象重命名为其他对象名。 PFSBucketAndObjectOperationSample 截断对象 obsClient.truncateObject(TruncateObjectRequest request) 截断对象操作是指将指定并行文件系统内的一个对象截断到指定大小。 PFSBucketAndObjectOperationSample