华为云用户手册

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

返回结果说明 表13 ObsObject 参数名称 参数类型 描述 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的字符串。 默认取值： 无 owner Owner 参数解释： 所有者，详见Owner。 metadata ObjectMetadata 参数解释： 对象元数据，详见ObjectMetadata。 objectContent InputStream 参数解释： 对象数据流。 默认取值： 无

代码示例 以下代码展示了如何重写响应头，并下载examplebucket桶中的objectname对象。 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.GetObjectRequest;import com.obs.services.model.ObjectRepleaceMetadata;import com.obs.services.model.ObsObject;public class GetObject005 { 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 { // 重写响应头 GetObjectRequest request = new GetObjectRequest("examplebucket", "objectname"); ObjectRepleaceMetadata replaceMetadata = new ObjectRepleaceMetadata(); replaceMetadata.setContentType("image/jpeg"); request.setReplaceMetadata(replaceMetadata); ObsObject obsObject = obsClient.getObject(request); System.out.println(obsObject.getMetadata().getContentType()); System.out.println("getObject successfully"); obsObject.getObjectContent().close(); } catch (ObsException e) { System.out.println("getObject 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("getObject failed"); // 其他异常信息打印 e.printStackTrace(); } }}

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

代码示例 图片处理下载。以下代码展示对examplebucket桶里的objectname.jpg图片对象进行缩放、旋转然后进行下载。 1 2 3 4 5 6 7 8 910111213141516171819202122232425262728293031323334353637383940414243444546474849505152 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.GetObjectRequest;import com.obs.services.model.ObsObject;public class GetObject008 { 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 { // 发起图片处理请求并下载 // examplebucket为桶名，objectname.jpg为对象名 GetObjectRequest request = new GetObjectRequest("examplebucket", "objectname.jpg"); // 设置图片处理参数，对图片依次进行缩放、旋转 request.setImageProcess("image/resize,m_fixed,w_100,h_100/rotate,90"); ObsObject obsObject = obsClient.getObject(request); System.out.println("getObject successfully"); obsObject.getObjectContent().close(); } catch (ObsException e) { System.out.println("getObject 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("getObject failed"); // 其他异常信息打印 e.printStackTrace(); } }}

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 所有的图片处理操作均不会修改存储在桶中的原图。 归档存储不支持图片处理。 深度归档存储不支持图片处理。 处理后的图片直接返回浏览器展示，不会保存在OBS中，也不会占用存储空间，不会产生存储费用。图片处理只收取处理的费用。

返回结果说明 getObject返回结果如下 表13 ObsObject 参数名称 参数类型 描述 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的字符串。 默认取值： 无 owner Owner 参数解释： 所有者，详见Owner。 metadata ObjectMetadata 参数解释： 对象元数据，详见ObjectMetadata。 objectContent InputStream 参数解释： 对象数据流。 默认取值： 无

请求参数说明 表1 uploadPart请求参数列表 参数名称 参数类型 是否必选 描述 request UploadPartRequest 必选 参数解释： 上传段请求参数，详见UploadPartRequest。 表2 UploadPartRequest 参数名称 参数类型 是否必选 描述 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的字符串。 默认取值： 无 partNumber int 必选 参数解释： 段号。 取值范围： [1,10000]，超出这个范围，OBS将返回400 Bad Request错误。 默认取值： 无 uploadId String 必选 参数解释： 分段上传任务的ID。任务ID可以通过初始化分段上传任务生成。例如：000001648453845DBB78F2340DD460D8。 约束限制： 长度为32的字符串。 默认取值： 无 input java.io.InputStream 可选 参数解释： 待上传对象的数据流。 约束限制： file为null，需要设置input字段不为空；input为null ，需要设置file字段不为空。二者需要选其一。 默认取值： 无 file java.io.File 可选 参数解释： 待上传对象的文件。 约束限制： file为null，需要设置input字段不为空；input为null ，需要设置file字段不为空。二者必须选其一。 默认取值： 无 offset long 可选 参数解释： 源文件中某一分段的起始偏移大小。流不支持该参数。 取值范围： 非负整数，不大于待上传对象的大小，单位：字节。 默认取值： 0 partSize Long 可选 参数解释： 当前段的长度。 约束限制： 上传段接口要求除最后一段以外，其他的段大小都要大于100KB。但是上传段接口并不会立即校验上传段的大小（因为不知道是否为最后一段），只有调用合并段接口时才会校验。 OBS 3.0的桶支持最小段的大小为100KB，OBS 2.0的桶支持最小段的大小为5MB。 取值范围： 100KB~5GB，单位：字节。 默认取值： 102400字节 sseCHeader SseCHeader 可选 参数解释： 服务端加密头域。详见SseCHeader。 默认取值： 无 attachMd5 boolean 可选 参数解释： 是否自动计算待上传数据的MD5值。为了保证数据在网络传输过程中不出现错误，可以通过设置UploadPartRequest.setAttachMd5为true来让SDK自动计算每段数据的MD5值（仅在数据源为本地文件时有效），并放到Content-MD5请求头中。OBS服务端会计算上传数据的MD5值与SDK计算的MD5值比较，保证数据完整性。 约束限制： attachMd5和contentMd5同时使用时，忽略attachMd5字段。 取值范围： true：自动计算上传数据的MD5值。 false：不自动计算上传数据的MD5值。 默认取值： false contentMd5 String 可选 参数解释： 待上传段数据的MD5值（经过Base64编码），是上传段数据内容的唯一标识，可以通过该值识别对象内容是否有变化。 约束限制： attachMd5和contentMd5同时使用时，忽略attachMd5字段。 取值范围： 长度为32的字符串。 默认取值： 无 progressListener ProgressListener 可选 参数解释： 上传进度，详见ProgressListener。 progressInterval long 可选 参数解释 上传进度反馈间隔。例子：1024 * 1024L，每上传1MB数据反馈上传进度。 默认取值： 100 * 1024L，单位：字节。 autoClose boolean 可选 参数解释： 上传完成后，自动关闭数据流。 取值范围： true：自动关闭数据流。 false：不自动关闭数据流。 默认取值： true 表3 SseCHeader 参数名称 参数类型 是否必选 描述 algorithm ServerAlgorithm 必选 参数解释： 表示服务端加密是SSE-C方式，对象使用SSE-C加密方式。 取值范围： 可选值：AES256，即选择SSE-C方式，使用高级加密标准（Advanced Encryption Standard，AES）加密对象。详见ServerAlgorithm。 默认取值： 无 sseAlgorithm SSEAlgorithmEnum 可选 参数解释： 加密算法。 约束限制： 只支持AES256。 取值范围： 详见SSEAlgorithmEnum。 默认取值： 无 sseCKey byte[] 必选 参数解释： SSE-C方式下加密使用的原始密钥，byte[]形式，该密钥用于加密对象。 默认取值： 无 sseCKeyBase64 String 可选 参数解释： SSE-C方式下的密钥，由原始密钥经过Base64编码后得到，该密钥用于加密对象。 默认取值： 无 表4 ServerAlgorithm 常量值 原始值 AES256 AES256 表5 SSEAlgorithmEnum 常量值 原始值 KMS kms AES256 AES256 表6 StorageClassEnum 常量名 原始值 说明 STANDARD STANDARD 标准存储。 WARM WARM 低频访问存储。 COLD COLD 归档存储。 DEEP_ARCHIVE DEEP_ARCHIVE 深度归档存储（受限公测） 表7 ProgressListener(传输进度接口)成员如下 方法名称 返回值类型 是否必选 描述 progressChanged void 必选 参数解释： 获取上传进度，详见progressChanged。 默认取值： 无 表8 progressChanged参数列表 参数名称 参数类型 是否必选 描述 status ProgressStatus 必选 参数解释： 传输进度数据，详见ProgressStatus。 默认取值： 无 表9 ProgressStatus方法 方法名称 返回值类型 说明 getAverageSpeed() double 上传平均速率。 getInstantaneousSpeed() double 上传瞬时速率。 getTransferPercentage() int 上传进度百分比。 getNewlyTransferredBytes() long 新增的字节数。 getTransferredBytes() long 已传输的字节数。 getTotalBytes() long 待传输的字节数。

功能说明 初始化分段上传任务后，通过分段上传任务的ID，上传段到指定桶中。除了最后一段以外，其他段的大小范围是100KB~5GB；最后一段的大小范围是0~5GB。上传的段的编号也有范围限制，其范围是1~10000。 上传段时，除了指定上传ID，还必须指定段编号。您可以选择1和10000之间的任意段编号。段编号在您正在上传的对象中唯一地标示了段及其位置。如果您使用之前上传的段的同一段编号上传新段，则之前上传的段将被覆盖。无论您何时上传段，OBS都将在其响应中返回ETag标头。对于每个段上传任务，您必须记录每个段编号和ETag值。您在后续的合并请求中需要添加这些值以完成多段上传。 开发过程中，您有任何问题可以在github上提交issue，或者在华为云 对象存储服务 论坛中发帖求助。

接口约束 您必须是桶拥有者或拥有上传段的权限，才能上传段。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 初始化上传段任务并上传一个或多个段之后，您必须合并段或取消多段上传任务，否则碎片会占用您的存储空间并产生一定的存储费用。 段任务中的partNumber是唯一的，重复上传相同partNumber的段，后一次上传会覆盖前一次上传内容。多并发上传同一对象的同一partNumber时，服务端遵循Last Write Win策略，但“Last Write”的时间定义为段元数据创建时间。为了保证数据准确性，客户端需要加锁保证同一对象的同一个段上传的并发性。同一对象的不同段并发上传不需要加锁。

代码示例 本示例用于获取下载examplebucket桶中objectname对象时的进度。示例代码如下： 1 2 3 4 5 6 7 8 910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.GetObjectRequest;import com.obs.services.model.ObsObject;import com.obs.services.model.ProgressListener;import com.obs.services.model.ProgressStatus;import java.io.ByteArrayOutputStream;import java.io.InputStream;public class GetObject003 { 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 { // 获取下载进度 GetObjectRequest request = new GetObjectRequest("examplebucket", "objectname"); request.setProgressListener( new ProgressListener() { @Override public void progressChanged(ProgressStatus status) { // 获取下载平均速率 System.out.println("AverageSpeed:" + status.getAverageSpeed()); // 获取下载进度百分比 System.out.println("TransferPercentage:" + status.getTransferPercentage()); } }); // 每下载1MB数据反馈下载进度 request.setProgressInterval(1024 * 1024L); ObsObject obsObject = obsClient.getObject(request); // 读取对象内容 System.out.println("Object content:"); InputStream input = obsObject.getObjectContent(); byte[] b = new byte[1024]; ByteArrayOutputStream bos = new ByteArrayOutputStream(); int len; while ((len = input.read(b)) != -1) { bos.write(b, 0, len); } System.out.println("getObjectContent successfully"); System.out.println(new String(bos.toByteArray())); bos.close(); input.close(); } catch (ObsException e) { System.out.println("getObjectContent 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("getObjectContent failed"); // 其他异常信息打印 e.printStackTrace(); } }}

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能获取下载进度。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 支持获取下载进度的接口包括：流式下载、范围下载和断点续传下载。

参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 progressListener ProgressListener 必选 参数解释： 设置数据传输监听器，用于获取下载进度，详见ProgressListener。 表2 ProgressListener(传输进度接口)成员如下 方法名称 返回值类型 是否必选 描述 progressChanged void 必选 参数解释： 获取上传进度，详见progressChanged。 表3 progressChanged参数列表 参数名称 参数类型 是否必选 描述 status ProgressStatus 必选 参数解释： 传输进度数据.，详见ProgressStatus。 表4 ProgressStatus方法 方法名称 返回值类型 说明 getAverageSpeed() double 上传平均速率。 getInstantaneousSpeed() double 上传瞬时速率。 getTransferPercentage() int 上传进度百分比。 getNewlyTransferredBytes() long 新增的字节数。 getTransferredBytes() long 已传输的字节数。 getTotalBytes() long 待传输的字节数。

代码示例 本示例用于限定条件下载examplebucket桶中的objectname对象，并且指定该文件的修改时间必须在“2016-01-01”之后才能下载成功。 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.GetObjectRequest;import com.obs.services.model.ObsObject;import java.text.SimpleDateFormat;public class GetObject004 { 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 { // 限定条件下载 GetObjectRequest request = new GetObjectRequest("examplebucket", "objectname"); request.setRangeStart(0l); request.setRangeEnd(1000l); request.setIfModifiedSince(new SimpleDateFormat("yyyy-MM-dd").parse("2016-01-01")); ObsObject obsObject = obsClient.getObject(request); System.out.println("getObject successfully"); obsObject.getObjectContent().close(); } catch (ObsException e) { System.out.println("getObject 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("getObject failed"); // 其他异常信息打印 e.printStackTrace(); } }}

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。

返回结果说明 表13 ObsObject 参数名称 参数类型 描述 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的字符串。 默认取值： 无 owner Owner 参数解释： 所有者，详见Owner。 metadata ObjectMetadata 参数解释： 对象元数据，详见ObjectMetadata。 objectContent InputStream 参数解释： 对象数据流。 默认取值： 无

代码示例：列举所有已上传的段 由于ObsClient.listParts只能列举至多1000个段，如果列举段数量大于1000个，可采用分页全部列举。示例如下： 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.ListPartsRequest;import com.obs.services.model.ListPartsResult;import com.obs.services.model.Multipart;public class ListParts002 { 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 uploadId = "upload id from initiateMultipartUpload"; // 列举所有已上传的段，其中uploadId来自于initiateMultipartUpload ListPartsRequest request = new ListPartsRequest("examplebucket", "objectname"); request.setUploadId(uploadId); ListPartsResult result; do { result = obsClient.listParts(request); for (Multipart part : result.getMultipartList()) { // 分段号，上传时候指定 System.out.println("PartNumber:" + part.getPartNumber()); // 段数据大小 System.out.println("Size:" + part.getSize()); // 分段的ETag值 System.out.println("Etag:" + part.getEtag()); // 段的最后上传时间 System.out.println("LastModified:" + part.getLastModified()); } request.setPartNumberMarker(Integer.parseInt(result.getNextPartNumberMarker())); } while (result.isTruncated()); System.out.println("listParts successfully"); } catch (ObsException e) { System.out.println("listParts 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("listParts failed"); // 其他异常信息打印 e.printStackTrace(); } }}

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 request ListPartsRequest 必选 参数解释： 列举上传段请求参数，详见ListPartsRequest。 表2 ListPartsRequest 参数名称 参数类型 是否必选 描述 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的字符串。 默认取值： 无 uploadId String 必选 参数解释： 分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8 取值范围： 长度大于0且不超过32的字符串。 默认取值： 无 maxParts Integer 可选 参数解释： 列举已上传段的返回结果最大段数目，即分页时每一页中段数目。 约束限制： 如果该参数超出1000时，则按照默认的1000进行处理。 取值范围： [1，1000] 默认取值： 1000 partNumberMarker Integer 可选 参数解释： 列举已上传段的起始位置。 约束限制： 只有PartNumber数目大于该参数的段会被列出 默认取值： 无 encodingType String 可选 参数解释： 对响应中的对象名key进行指定类型的编码。如果key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的key进行编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。

功能说明 通过分段上传任务的ID，列举指定桶中已上传的段。 您可以列出特定多段上传任务或所有正在进行的多段上传任务的分段。列举已上传的段操作将返回特定多段上传任务中正在进行上传的段信息，单次最多列举1000个分段。如果多段上传中的段超过1000个，您必须发送一系列列举已上传的段请求以检索所有段。请注意，返回的分段列表不包括已合并的分段。 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

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

代码示例：简单列举已上传的段（最多1000个） 通过initiateMultipartUpload获取的uploadId对examplebucket桶下的objectname对象进行上传段的简单列举，至多列举1000个段。 1 2 3 4 5 6 7 8 910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.ListPartsRequest;import com.obs.services.model.ListPartsResult;import com.obs.services.model.Multipart;public class ListParts001 { 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 uploadId = "upload id from initiateMultipartUpload"; // 列举已上传的段，其中uploadId来自于initiateMultipartUpload ListPartsRequest request = new ListPartsRequest("examplebucket", "objectname"); request.setUploadId(uploadId); ListPartsResult result = obsClient.listParts(request); for (Multipart part : result.getMultipartList()) { // 分段号，上传时候指定 System.out.println("PartNumber:" + part.getPartNumber()); // 段数据大小 System.out.println("Size:" + part.getSize()); // 分段的ETag值 System.out.println("Etag:" + part.getEtag()); // 段的最后上传时间 System.out.println("LastModified:" + part.getLastModified()); } System.out.println("listParts successfully"); } catch (ObsException e) { System.out.println("listParts 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("listParts failed"); // 其他异常信息打印 e.printStackTrace(); } }}

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。 ObsObject.getObjectContent获取的对象输入流一定要显式关闭，否则会造成资源泄露。

代码示例 本示例用于流式下载examplebucket桶中的objectname对象。 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 import com.obs.services.ObsClient;import com.obs.services.exception.ObsException;import com.obs.services.model.ObsObject;import java.io.ByteArrayOutputStream;import java.io.InputStream;public class GetObject001 { 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, 此处以华北-北京四为例，其他地区请按实际情况填写。查看桶所在的endpoint请参见：https://support.huaweicloud.com/usermanual-obs/obs_03_0312.html。 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 { // 流式下载 ObsObject obsObject = obsClient.getObject("examplebucket", "objectname"); // 读取对象内容 System.out.println("Object content:"); InputStream input = obsObject.getObjectContent(); byte[] b = new byte[1024]; ByteArrayOutputStream bos = new ByteArrayOutputStream(); int len; while ((len = input.read(b)) != -1) { bos.write(b, 0, len); } System.out.println("getObjectContent successfully"); System.out.println(new String(bos.toByteArray())); bos.close(); input.close(); } catch (ObsException e) { System.out.println("getObjectContent 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("getObjectContent failed"); // 其他异常信息打印 e.printStackTrace(); } }}

返回结果说明 表13 ObsObject 参数名称 参数类型 描述 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的字符串。 默认取值： 无 owner Owner 参数解释： 所有者，详见Owner。 metadata ObjectMetadata 参数解释： 对象元数据，详见ObjectMetadata。 objectContent InputStream 参数解释： 对象数据流。 默认取值： 无

接口约束 您必须是桶拥有者或拥有合并段的权限，才能合并段。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 如果上传了10个段，但合并时只选择了9个段进行合并，那么未被合并的段将会被系统自动删除，未被合并的段删除后不能恢复。在进行合并之前请使用列出已上传的段接口进行查询，仔细核对所有段，确保没有段被遗漏。

功能说明 如果用户上传完所有的段，就可以调用合并段接口，系统将在服务端将用户指定的段合并成一个完整的对象。在执行“合并段”操作以前，用户不能下载已经上传的数据。在合并段时需要将多段上传任务初始化时记录的附加消息头信息拷贝到对象元数据中，其处理过程和普通上传对象带这些消息头的处理过程相同。在并发合并段的情况下，仍然遵循Last Write Win策略，但“Last Write”的时间定义为段任务的初始化时间。 已经上传的段，只要没有取消对应的多段上传任务，都要占用用户的容量配额；对应的多段上传任务“合并段”操作完成后，只有指定的多段数据占用容量配额，用户上传的其他此多段任务对应的段数据如果没有包含在“合并段”操作指定的段列表中，“合并段”完成后系统将删除多余的段数据，且同时释放容量配额。 合并段时，OBS通过按升序的段编号规范化多段来创建对象。如果在初始化上传段任务中提供了任何对象元数据，则OBS会将该元数据与对象相关联。成功完成请求后，段将不再存在。合并段请求必须包括上传ID、段编号和相应的ETag值的列表。OBS响应包括可唯一地识别组合对象数据的ETag。此ETag无需成为对象数据的MD5哈希。 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

功能说明 对于较大文件上传，可以切分成段上传。用户可以在如下的应用场景内（但不仅限于此），使用分段上传的模式： 上传超过100MB大小的文件。 网络条件较差，和OBS服务端之间的链接经常断开。 上传前无法确定将要上传文件的大小。 使用分段上传具有以下优势： 提高吞吐量——您可以使用并行上传段以提高吞吐量。 从任何网络问题中快速恢复——较小的段大小可以将由于网络错误而需重启失败的上传所产生的影响降至最低。 暂停和恢复对象上传——您可以随时上传对象段。启动多段上传后，不存在过期期限；您必须显式地完成或取消多段上传任务。 在得知最终对象大小之前开始上传——您可以在创建对象的同时上传对象。 分段上传分为如下3个步骤： 初始化分段上传任务（ObsClient.initiateMultipartUpload）。 逐个或并行上传段（ObsClient.uploadPart）。 合并段（ObsClient.completeMultipartUpload）或取消分段上传任务(ObsClient.abortMultipartUpload)。

背景信息 HA英文全称High Availability，即高可用性，通常指采用主、备两个相同的模块以热备份或者冷备份的方式完成指定功能，在主用模块故障时，备用模块会自动接替主用模块执行系统功能，以提高系统可靠性。 eBackup备份管理系统支持HA功能，需要规划至少两个eBackup服务器（将其中一台服务器初始化为备份服务器，其余服务器初始化为备份代理）。默认情况下，完成安装配置后系统不启用HA功能，需要用户设置HA参数，将eBackup配置为高可用系统。设置完成后，备份服务器和一个备份代理互为主备节点。当备份服务器故障时，备份代理代替其维持系统正常运行。

关于用户 通过配置不同用户，可以实现系统安全策略的配置、业务的分权管理，并可以实时监控、管理在线用户。 用户角色和权限 eBackup备份管理系统提供三种管理用户级别，分别为“超级管理员”、“管理员”、“普通用户”，各自的权限说明如表1所示。 系统最多允许创建2000个用户。 表1 用户权限说明 用户角色 权限说明 超级管理员 系统提供一个默认超级管理员admin，该用户拥有所有操作权限、可以管理所有资源。默认超级管理员不能被修改用户名、重置密码、删除、锁定和强制下线，超级管理员可以修改自身登录密码。通过默认超级管理员可以创建新的“管理员”和“普通用户”角色的用户，实现对业务的分权管理。 管理员 具有除系统设置之外的其他所有权限。使用“管理员”角色的用户登录系统仅可以查看到自身的用户信息、自身操作和系统产生的事件信息。 普通用户 对于系统资源，普通用户仅具有查看权限。使用“普通用户”角色的用户登录系统仅可以查看到自身的用户信息、自身操作和系统产生的事件信息。 系统安全策略 系统安全策略包括密码策略和登录策略，具体配置操作请参见相关操作中的“配置安全策略”。 密码策略定义了eBackup备份管理系统登录用户的密码长度、复杂度、有效期、过期提示时间阈值等参数。 登录策略定义了用户登录eBackup备份管理系统的会话超时时间，以及连续输入错误密码达到一定次数后，是否被系统自动锁定以及多长时间后自动解锁。 eBackup备份管理系统的所有账号信息请参见账号信息一览表。

典型组网建议 默认情况下eBackup有五个网络平面，您需要为每个网络平面规划IP地址，以保证eBackup与周边其他组件正常通信。网络平面的详细说明如网络平面介绍所示。本节介绍VMware备份上云中eBackup的典型组网建议。 为eBackup规划2个IP地址：内网IP地址和公网IP地址 该场景下请确保内网IP地址与访问eBackup管理平面的终端、vCenter Server/ESXi主机以及生产存储网络连通；确保公网IP地址与备份存储网络连通。 此时需要为eBackup配置2张网卡，一张配置为内网IP地址，一张配置为公网IP地址。 eBackup的生产管理平面、备份管理平面、内部通信平面、生产存储平面四平面合一，均绑定在内网IP地址的网卡上；eBackup的备份存储平面绑定在公网IP地址的网卡上。 eBackup网络平面IP地址及周边组件的IP地址配置示例如表1所示。 为eBackup规划1个IP地址 该场景下请确保该IP地址与访问eBackup管理平面的终端、vCenter Server/ESXi主机、生产存储以及备份存储网络连通。 此时需要为eBackup配置1张网卡，配置为内网IP地址。 eBackup的所有网络平面合一，eBackup的生产管理平面、备份管理平面、内部通信平面、生产存储平面、备份存储平面均绑定在同一张网卡上。 eBackup网络平面IP地址及周边组件的IP地址配置示例如表1所示。