华为云用户手册

简单创建 以下代码展示如何新建一个桶： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AC CES S_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);// 创建桶try{ // 创建桶成功 HeaderResponse response = obsClient.createBucket("bucketname"); Log.i("CreateBucket", response.getRequestId());}catch (ObsException e){ // 创建桶失败 Log.e("CreateBucket", "Response Code: " + e.getResponseCode()); Log.e("CreateBucket", "Error Message: " + e.getErrorMessage()); Log.e("CreateBucket", "Error Code: " + e.getErrorCode()); Log.e("CreateBucket", "Request ID: " + e.getErrorRequestId()); Log.e("CreateBucket", "Host ID: " + e.getErrorHostId());} 桶的名字是全局唯一的，所以您需要确保不与已有的桶名称重复。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用类IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 本示例创建的桶的访问权限默认是私有读写，存储类型默认是标准类型，区域位置是默认区域。

上传字符串（byte数组） // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);String content = "Hello OBS";obsClient.putObject("bucketname", "objectname", new ByteArrayInputStream(content.getBytes()));

上传文件流 // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);FileInputStream fis = new FileInputStream(new File("localfile")); // localfile为待上传的本地文件路径，需要指定到具体的文件名obsClient.putObject("bucketname", "objectname", fis);// 待上传的本地文件路径，需要指定到具体的文件名FileInputStream fis2 = new FileInputStream(new File("localfile2"));PutObjectRequest request = new PutObjectRequest();request.setBucketName("bucketname");request.setObjectKey("objectname2");request.setInput(fis2);obsClient.putObject(request); 推荐使用文件上传的形式上传本地文件，而不是文件流形式。 大文件上传建议使用分段上传。 上传的内容大小不能超过5GB。 由于 HTTP 编码规范限制，无法发送非 ASCII 码字符，SDK 会在发送请求时对您头域中的中文汉字进行 url 编码，发送编码后数据。如您设置的值 content-disposition 为“attachment; filename="中文.txt"” ，则对象元数据中存储的信息为“attachment; filename="%E4%B8%AD%E6%96%87.txt"”。使用浏览器访问时浏览器将会自动解码。 如果不需要 SDK 帮您编码，可以调用 PutObjectRequest.setIsEncodeHeaders(false) 关闭自动编码。

使用前需知 开发过程中，您有任何问题可以在github上提交issue，或者在华为云 对象存储服务 论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 请确认您已经熟悉OBS的基本概念，如桶（Bucket）、对象（Object）、访问密钥（AK和SK）等。 您可以先参考OBS客户端通用示例，了解OBS Android SDK接口调用的通用方式。 使用OBS客户端进行接口调用操作完成后，没有异常抛出，则表明返回值有效；如果抛出异常，则说明操作失败，此时应可SDK自定义异常实例中获取错误信息。 使用OBS客户端进行接口调用成功后，均会返回包含响应头信息的SDK公共响应头实例（或其子类实例）。 当前各区域特性开放不一致，部分特性只在部分区域开放，使用过程中如果接口HTTP状态码为405，请确认该区域是否支持该功能特性。 父主题： 快速入门

删除桶 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 您可以通过ObsClient.deleteBucket删除桶。以下代码展示如何删除一个桶： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);// 删除桶obsClient.deleteBucket("bucketname"); 如果桶不为空（包含对象或分段上传碎片），则该桶无法删除。 删除桶非幂等操作，删除不存在的桶会报错。 父主题： 管理桶

判断桶是否存在 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 您可以通过ObsClient.headBucket接口判断该桶是否已存在。以下代码展示如何判断指定桶是否存在： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);boolean exists = obsClient.headBucket("bucketname"); 父主题： 管理桶

文件上传 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 文件上传使用本地文件作为对象的数据源。以下代码展示了如何进行文件上传： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);try { // 文件上传 // localfile 为待上传的本地文件路径，需要指定到具体的文件名 PutObjectRequest request = new PutObjectRequest(); request.setBucketName("examplebucket"); request.setObjectKey("objectkey"); request.setFile(new File("localfile")); obsClient.putObject(request); 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();} 上传内容大小不能超过5GB。 由于 HTTP 编码规范限制，无法发送非 ASCII 码字符，SDK 会在发送请求时对您头域中的中文汉字进行 url 编码，发送编码后数据。如您设置的值 content-disposition 为“attachment; filename="中文.txt"” ，则对象元数据中存储的信息为“attachment; filename="%E4%B8%AD%E6%96%87.txt"”。使用浏览器访问时浏览器将会自动解码。 如果不需要 SDK 帮您编码，可以调用 PutObjectRequest.setIsEncodeHeaders(false) 关闭自动编码。如需使用该功能，请安装最新版本的SDK。 父主题： 上传对象

上传对象 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 以下代码展示如何上传对象至OBS： obsClient.putObject("bucketname", "objectname", new ByteArrayInputStream("Hello OBS".getBytes())); 更多上传对象的信息，请参见上传对象。 父主题： 快速入门

断点续传上传 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 当上传大文件时，经常出现因网络不稳定或程序崩溃导致上传失败的情况。失败后再次重新上传不仅浪费资源，而且当网络不稳定时仍然有上传失败的风险。断点续传上传接口能有效地解决此类问题引起的上传失败，其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则抛出异常提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。 您可以通过ObsClient.uploadFile进行断点续传上传。该接口可设置的参数如下： 参数 作用 OBS Android SDK对应方法 bucketName 桶名，必选参数。 UploadFileRequest.setBucketName objectKey 对象名，必选参数。 UploadFileRequest.setObjectKey uploadFile 待上传的本地文件，必选参数。 UploadFileRequest.setUploadFile partSize 分段大小，单位字节，取值范围是100KB~5GB，默认为5MB。 UploadFileRequest.setPartSize taskNum 分段上传时的最大并发数，默认为1。 UploadFileRequest.setTaskNum enableCheckpoint 是否开启断点续传模式，默认为false，表示不开启。 UploadFileRequest.setEnableCheckpoint isEncodeHeaders 是否自动编码请求头 UploadFileRequest.setIsEncodeHeaders checkpointFile 记录上传进度的文件，只在断点续传模式下有效。当该值为空时，默认与待上传的本地文件同目录。 UploadFileRequest.setCheckpointFile objectMetadata 对象的属性。 UploadFileRequest.setObjectMetadata enableCheckSum 是否校验待上传文件的内容，只在断点续传模式下有效。默认为false，表示不校验。 UploadFileRequest.setEnableCheckSum progressListener 设置数据传输监听器，用于获取上传进度。 UploadFileRequest.setProgressListener 以下代码展示了如何使用断点续传上传接口上传文件： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint); UploadFileRequest request = new UploadFileRequest("bucketname", "objectname");// 设置待上传的本地文件，其中localfile为待上传的本地文件路径，需要指定到具体的文件名request.setUploadFile("localfile");// 设置分段上传时的最大并发数request.setTaskNum(5);// 设置分段大小为10MBrequest.setPartSize(10 * 1024 * 1024);// 开启断点续传模式request.setEnableCheckpoint(true);try{ // 进行断点续传上传 CompleteMultipartUploadResult result = obsClient.uploadFile(request);}catch (ObsException e) { // 发生异常时可再次调用断点续传上传接口进行重新上传} 断点续传上传接口是利用分段上传特性实现的，是对分段上传的封装和加强。 断点续传上传接口不仅能在失败重传时节省资源提高效率，还因其对分段进行并发上传的机制能加快上传速度，帮助用户快速完成上传业务；且其对用户透明，用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发上传的实现等内部细节。 enableCheckpoint参数默认是false，代表不启用断点续传模式，此时断点续传上传接口退化成对分段上传的简单封装，不会产生checkpoint文件。 checkpointFile参数和enableCheckSum参数仅在enableCheckpoint参数为true时有效。 由于 HTTP 编码规范限制，无法发送非 ASCII 码字符，SDK 会在发送请求时对您头域中的中文汉字进行 url 编码，发送编码后数据。如您设置的值 content-disposition 为“attachment; filename="中文.txt"” ，则对象元数据中存储的信息为“attachment; filename="%E4%B8%AD%E6%96%87.txt"”。使用浏览器访问时浏览器将会自动解码。 如果不需要 SDK 帮您编码，可以调用 UploadFileRequest.setIsEncodeHeaders(false) 关闭自动编码。 断点续传上传功能暂不支持暂停或取消操作。 父主题： 上传对象

下载对象 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 以下代码展示如何获取对象的内容： ObsObject obsObject = obsClient.getObject("bucketname", "objectname");InputStream content = obsObject.getObjectContent();if (content != null){ BufferedReader reader = new BufferedReader(new InputStreamReader(content)); while (true) { String line = reader.readLine(); if (line == null) break; Log.i("GetObject", "\n" + line); } reader.close();} 调用ObsClient.getObject返回一个ObsObject实例，该实例包含对象内容及其属性。 调用ObsObject.getObjectContent获取对象输入流，可读取此输入流获取其内容，用完之后请关闭这个流。 更多下载对象的信息，请参见下载对象。 父主题： 快速入门

创建桶 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 桶是OBS全局命名空间，相当于数据的容器、文件系统的根目录，可以存储若干对象。以下代码展示如何新建一个桶： obsClient.createBucket("bucketname"); 桶的名字是全局唯一的，所以您需要确保不与已有的桶名称重复。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用类IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 更多创建桶的信息，请参见创建桶。 创建桶时，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），则可以不指定区域；如果使用的终端节点归属于其他区域，则必须指定区域，且指定的区域必须与终端节点归属的区域一致。当前有效的区 域名 称可从这里查询。 您可以使用带参数创建方式，在创建桶时，指定桶的区域位置。 父主题： 快速入门

获取桶元数据 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 您可以通过ObsClient.getBucketMetadata接口获取桶元数据。以下代码展示如何获取桶元数据： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);BucketMetadataInfoRequest request = new BucketMetadataInfoRequest("bucketname");request.setOrigin("http://www.a.com");//获取桶元数据BucketMetadataInfoResult result = obsClient.getBucketMetadata(request);Log.i("GetBucketMetadata", "\t:" + result.getDefaultStorageClass());Log.i("GetBucketMetadata", "\t:" + result.getAllowOrigin());Log.i("GetBucketMetadata", "\t:" + result.getMaxAge());Log.i("GetBucketMetadata", "\t:" + result.getAllowHeaders());Log.i("GetBucketMetadata", "\t:" + result.getAllowMethods());Log.i("GetBucketMetadata", "\t:" + result.getExposeHeaders()); BucketMetadataInfoResult.getAllowMethods等方法的值参见桶的跨域资源共享（CORS）配置。 父主题： 管理桶

获取桶存量信息 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 桶存量信息包括桶已使用的空间大小以及桶包含的对象个数。您可以通过ObsClient.getBucketStorageInfo获取桶的存量信息。以下代码展示如何获取桶存量信息： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);BucketStorageInfo storageInfo = obsClient.getBucketStorageInfo("bucketname");Log.i("GetBucketStorageInfo", "\t" + storageInfo.getObjectNumber());Log.i("GetBucketStorageInfo", "\t" + storageInfo.getSize()); 父主题： 管理桶

设置对象长度 您可以通过ObjectMetadata.setContentLength来设置对象长度。以下代码展示如何设置对象长度： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);ObjectMetadata metadata = new ObjectMetadata();metadata.setContentLength(1024 * 1024L);//1MBobsClient.putObject("bucketname", "objectname", new File("localfile"), metadata);

追加上传 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 追加上传可实现对同一个对象追加数据内容的功能。您可以通过ObsClient.appendObject进行追加上传。示例代码如下： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);// 第一次追加上传AppendObjectRequest request = new AppendObjectRequest();request.setBucketName("bucketname");request.setObjectKey("objectname");request.setPosition(0L);request.setInput(new ByteArrayInputStream("Hello OBS".getBytes()));AppendObjectResult result = obsClient.appendObject(request); // 第二次追加上传request.setPosition(result.getNextPosition());request.setInput(new ByteArrayInputStream("Hello OBS Again".getBytes()));result = obsClient.appendObject(request);Log.i("AppendObject", "NextPosition:" + result.getNextPosition());Log.i("AppendObject", "Etag:" + result.getEtag());// 通过获取对象属性接口获取下次追加上传的位置ObjectMetadata metadata = obsClient.getObjectMetadata("bucketname", "objectname");Log.i("AppendObject", "NextPosition from metadata:" + metadata.getNextPosition()); ObsClient.putObject上传的对象可覆盖ObsClient.appendObject上传的对象，覆盖后对象变为普通对象，不可再进行追加上传。 第一次调用追加上传时，如果已存在同名的普通对象，则会抛出异常（HTTP状态码为409）。 追加上传返回的ETag是追加数据内容的ETag，不是完整对象的ETag。 单次追加上传的内容不能超过5GB，且最多支持10000次追加上传。 追加上传成功后，可通过AppendObjectResult.getNextPosition获取下次追加上传的位置；或者通过ObsClient.getObjectMetadata接口获取下次追加上传的位置。 由于 HTTP 编码规范限制，无法发送非 ASCII 码字符，SDK 会在发送请求时对您头域中的中文汉字进行 url 编码，发送编码后数据。如您设置的值 content-disposition 为“attachment; filename="中文.txt"” ，则对象元数据中存储的信息为“attachment; filename="%E4%B8%AD%E6%96%87.txt"”。使用浏览器访问时浏览器将会自动解码。 如果不需要 SDK 帮您编码，可以调用 AppendObjectRequest.setIsEncodeHeaders(false) 关闭自动编码。 父主题： 上传对象

设置对象MIME类型 您可以通过ObjectMetadata.setContentType来设置对象MIME类型。以下代码展示如何设置对象MIME类型： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);// 上传图片ObjectMetadata metadata = new ObjectMetadata();metadata.setContentType("image/jpeg");obsClient.putObject("bucketname", "objectname", new File("localimage.jpg"), metadata);

设置对象MD5值 您可以通过ObjectMetadata.setContentMd5来设置对象MD5值。以下代码展示如何设置对象MD5值： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);// 上传图片ObjectMetadata metadata = new ObjectMetadata();metadata.setContentMd5("your md5 which should be encoded by base64");obsClient.putObject("bucketname", "objectname", new File("localimage.jpg"), metadata);

设置对象存储类型 您可以通过ObjectMetadata.setStorageClass来设置对象存储类型。以下代码展示如何设置对象存储类型： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);ObjectMetadata metadata = new ObjectMetadata();// 设置对象存储类型为低频访问存储metadata.setObjectStorageClass(StorageClassEnum.WARM);obsClient.putObject("bucketname", "objectname", new File("localfile"), metadata);

设置对象自定义元数据 您可以通过ObjectMetadata.addUserMetadata来设置对象自定义元数据。以下代码展示如何设置对象自定义元数据： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);ObjectMetadata metadata = new ObjectMetadata();metadata.addUserMetadata("property1", "property-value1");metadata.getMetadata().put("property2", "property-value2");obsClient.putObject("bucketname", "objectname", new File("localfile"), metadata);

配置SDK日志 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 OBS Android SDK基于java.util.logging库提供了日志功能，您可以通过LogConfigurator.enableLog开启或LogConfigurator.disableLog关闭日志功能。示例代码如下： // 设置日志的级别。默认为LogConfigurator.WARNLogConfigurator.setLogLevel(LogConfigurator.INFO);// 设置保留日志文件的个数。默认为10LogConfigurator.setLogFileRolloverCount(5);// 设置每个日志文件的大小，单位：字节。默认为不限制LogConfigurator.setLogFileSize(1024 * 1024 * 10);// 设置日志文件存放的目录，默认存放在SD卡的logs目录下。此处以“/storage/sdcard”为例，用户可根据自身情况调整LogConfigurator.setLogFileDir("/storage/sdcard");// 开启日志LogConfigurator.enableLog();// 关闭日志LogConfigurator.disableLog(); 日志功能默认是关闭的，需要主动开启。 您可以从 日志分析 章节获取更多关于SDK日志的介绍。 如果不设置日志文件存放的目录，日志文件默认存放于SD卡的logs目录下。 父主题： 初始化

配置OBS客户端 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 当使用配置类（ObsConfiguration）创建OBS客户端（ObsClient）时，您可通过ObsConfiguration配置类对ObsClient进行配置，可配置代理、连接超时、最大连接数等参数。通过ObsConfiguration可以设置的参数见下表： 参数 描述 方法 建议值 connectionTimeout 建立HTTP/HTTPS连接的超时时间（单位：毫秒）。默认为60000毫秒。 ObsConfiguration.setConnectionTimeout [10000, 60000] socketTimeout Socket层传输数据的超时时间（单位：毫秒）。默认为60000毫秒。 ObsConfiguration.setSocketTimeout [10000, 60000] idleConnectionTime 如果空闲时间超过此参数的设定值，则关闭连接（单位：毫秒）。默认为30000毫秒。 ObsConfiguration.setIdleConnectionTime 默认 maxIdleConnections 连接池中最大空闲连接数，默认值：1000。 ObsConfiguration.setMaxIdleConnections N/A maxConnections 最大允许的HTTP并发请求数。默认为1000。 ObsConfiguration.setMaxConnections 默认 maxErrorRetry 请求失败（请求异常、服务端报500或503错误等）后最大的重试次数。默认3次。 说明： 该参数对于上传对象和下载对象接口时，当上传或下载已经进入数据流处理阶段后产生异常中断，此时将不会重试。 ObsConfiguration.setMaxErrorRetry [0, 5] endPoint 连接OBS的服务地址。可包含协议类型、域名、端口号。示例：https://your-endpoint:443。 （出于安全性考虑，建议使用https协议） ObsConfiguration.setEndPoint N/A httpProxy HTTP代理配置。默认为空。 ObsConfiguration.setHttpProxy N/A validateCertificate 是否验证服务端证书。默认为false。 ObsConfiguration.setValidateCertificate N/A verifyResponseContentType 是否验证响应头信息的ContentType。默认为true。 ObsConfiguration.setVerifyResponseContentType 默认 uploadStreamRetryBufferSize 上传流对象时使用的缓存大小（单位：字节）。默认为512KB。 ObsConfiguration.setUploadStreamRetryBufferSize N/A readBufferSize 从Socket流下载对象的缓存大小（单位：字节），-1表示不设置缓存。默认为-1。 ObsConfiguration.setReadBufferSize N/A writeBufferSize 上传对象到Socket流时的缓存大小（单位：字节），-1表示不设置缓存。默认为-1。 ObsConfiguration.setWriteBufferSize N/A socketWriteBufferSize Socket发送缓冲区大小（单位：字节），对应java.net.SocketOptions.SO_SNDBUF参数。默认为-1表示不设置。 ObsConfiguration.setSocketWriteBufferSize 默认 socketReadBufferSize Socket接收缓冲区大小（单位：字节），对应java.net.SocketOptions.SO_RCVBUF参数。默认为-1表示不设置。 ObsConfiguration.setSocketReadBufferSize 默认 keyManagerFactory 用于生成javax.net.ssl.KeyManager的工厂。默认为空。 ObsConfiguration.setKeyManagerFactory N/A trustManagerFactory 用于生成javax.net.ssl.TrustManager的工厂。默认为空。 ObsConfiguration.setTrustManagerFactory N/A isStrictHostnameVerification 是否严格验证服务端主机名。默认为false。 ObsConfiguration.setIsStrictHostnameVerification N/A keepAlive 是否使用长连接访问OBS服务。默认为true。 ObsConfiguration.setKeepAlive N/A cname 是否通过自定义域名访问OBS服务。默认为false。 ObsConfiguration.setCname N/A sslProvider SSLContext的Provider，默认使用JDK提供的SSLContext。 ObsConfiguration.setSslProvider N/A httpProtocolType 访问OBS服务端时使用的HTTP协议类型。默认为HTTP1.1协议。 ObsConfiguration.setHttpProtocolType N/A httpDispatcher 自定义分发器。 ObsConfiguration.setHttpDispatcher N/A 建议值为N/A的表示需要根据实际情况进行设置。 如需提高大文件上传下载性能，在网络带宽满足的情况下，可对socketWriteBufferSize，sockeReadBufferSize，readBufferSize，writeBufferSize四个参数进行调优。 如网络状况不佳，建议增大connectionTimeout和socketTimeout的值。 如果设置的endPoint不带协议类型，则默认使用HTTPS协议。 出于DNS解析性能和OBS服务可靠性的考虑，不允许将endPoint设置为IP，必须使用域名访问OBS服务。 父主题： 初始化

删除桶策略 您可以通过ObsClient.deleteBucketPolicy删除桶策略。示例代码如下： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);obsClient.deleteBucketPolicy("bucketname");

设置桶策略 您可以通过ObsClient.setBucketPolicy设置桶策略。示例代码如下： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);obsClient.setBucketPolicy("bucketname", "your policy"); 桶策略内容的具体格式（JSON格式字符串）请参考《对象存储服务API参考》。

获取桶策略 您可以通过ObsClient.getBucketPolicy获取桶策略。示例代码如下： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);String policy = obsClient.getBucketPolicy("bucketname");Log.i("GetBucketPolicy","\t" + policy);

设置桶配额 您可以通过ObsClient.setBucketQuota设置桶配额。以下代码展示如何设置桶配额： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);// 设置桶配额为100MBBucketQuota quota = new BucketQuota(1024 * 1024 * 100);obsClient.setBucketQuota("bucketname", quota); 桶配额值必须为非负整数，单位为字节，支持的最大值为263 - 1。

查看生命周期规则 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 您可以通过ObsClient.getBucketLifecycle查看桶的生命周期规则。以下代码展示了如何查看桶的生命周期规则： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);LifecycleConfiguration config = obsClient.getBucketLifecycle("bucketname");for (LifecycleConfiguration.Rule rule : config.getRules()) { Log.i("GetBucketLifecycleConfiguration",rule.getId()); Log.i("GetBucketLifecycleConfiguration",rule.getPrefix()); for(LifecycleConfiguration.Transition transition : rule.getTransitions()){ Log.i("GetBucketLifecycleConfiguration",String.valueOf(transition.getDays())); Log.i("GetBucketLifecycleConfiguration",transition.getStorageClass()); } Log.i("GetBucketLifecycleConfiguration",rule.getExpiration() != null ? String.valueOf(rule.getExpiration().getDays()) : ""); for(LifecycleConfiguration.NoncurrentVersionTransition noncurrentVersionTransition : rule.getNoncurrentVersionTransitions()){ Log.i("GetBucketLifecycleConfiguration",String.valueOf(noncurrentVersionTransition.getDays())); Log.i("GetBucketLifecycleConfiguration",noncurrentVersionTransition.getStorageClass()); } Log.i("GetBucketLifecycleConfiguration",rule.getNoncurrentVersionExpiration() != null ?String.valueOf(rule.getNoncurrentVersionExpiration().getDays()) : "");} 父主题： 生命周期管理

删除生命周期规则 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。 您可以通过ObsClient.deleteBucketLifecycle删除桶的生命周期规则。以下代码展示了如何删除桶的生命周期规则： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);obsClient.deleteBucketLifecycle("bucketname"); 父主题： 生命周期管理

获取桶配额 您可以通过ObsClient.getBucketQuota获取桶配额。以下代码展示如何获取桶配额： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);BucketQuota quota = obsClient.getBucketQuota("bucketname");Log.i("GetBucketQuota", "\t" + quota.getBucketQuota());

设置对象转换策略 以下代码展示了如何设置最新版本对象和历史版本对象的转换策略： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例ObsClient obsClient = new ObsClient(ak, sk, endPoint);LifecycleConfiguration config = new LifecycleConfiguration();LifecycleConfiguration.Rule rule = config.new Rule();rule.setEnabled(true);rule.setId("rule1");rule.setPrefix("prefix");LifecycleConfiguration.Transition transition = config.new Transition();// 指定满足前缀的对象创建30天后转换transition.setDays(30);// 指定对象转换后的存储类型transition.setObjectStorageClass(StorageClassEnum.STANDARD);// 直接指定满足前缀的对象转换日期// transition.setDate(new SimpleDateFormat("yyyy-MM-dd").parse("2018-10-31")); rule.getTransitions().add(transition);LifecycleConfiguration.NoncurrentVersionTransition noncurrentVersionTransition = config.new NoncurrentVersionTransition();// 指定满足前缀的对象成为历史版本30天后转换noncurrentVersionTransition.setDays(30);// 指定历史版本对象转换后的存储类型noncurrentVersionTransition.setObjectStorageClass(StorageClassEnum.COLD);rule.getNoncurrentVersionTransitions().add(noncurrentVersionTransition);config.addRule(rule);obsClient.setBucketLifecycle("bucketname", config);

简单列举 以下代码展示如何简单列举对象，最多返回1000个对象： // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.htmlString ak = System.getenv("ACCESS_KEY_ID");String sk = System.getenv("SECRET_ACCESS_KEY_ID");String endPoint = "https://your-endpoint";// 创建ObsClient实例final ObsClient obsClient = new ObsClient(ak, sk, endPoint);ObjectListing result = obsClient.listObjects("bucketname");for(ObsObject obsObject : result.getObjects()){ Log.i("ListObjects", "\t" + obsObject.getObjectKey()); Log.i("ListObjects","\t" + obsObject.getOwner());} 每次至多返回1000个对象，如果指定桶包含的对象数量大于1000，则返回结果中ObjectListing.isTruncated为true表明本次没有返回全部对象，并可通过ObjectListing.getNextMarker获取下次列举的起始位置。 如果想获取指定桶包含的所有对象，可以采用分页列举的方式。