下载对象-华为云

对象存储服务 OBS-获取自定义元数据(Java SDK):代码示例

代码示例本示例通过下载examplebucket桶中的objectname对象成功后，返回自定义元数据。示例代码如下： 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 import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.GetObjectRequest; import com.obs.services.model.ObjectMetadata; import com.obs.services.model.ObsObject; import com.obs.services.model.PutObjectRequest; public class GetObject006 { 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 { // 获取自定义元数据 // 上传对象，设置自定义元数据 PutObjectRequest request = new PutObjectRequest("examplebucket", "objectname"); ObjectMetadata metadata = new ObjectMetadata(); metadata.addUserMetadata("property", "property-value"); request.setMetadata(metadata); obsClient.putObject(request); // 下载对象，获取对象自定义元数据 GetObjectRequest request1 = new GetObjectRequest("examplebucket", "objectname"); ObsObject obsObject = obsClient.getObject(request1); System.out.println("getObject successfully"); // 读取对象元数据 System.out.println(obsObject.getMetadata().getContentType()); // 获取名为property的自定义元数据 System.out.println(obsObject.getMetadata().getUserMetadata("property")); // 获取所有自定义元数据 System.out.println("allUserMetadata:" + metadata.getAllMetadata()); 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(); } } }

对象存储服务 OBS 下载对象(Java SDK)

对象存储服务 OBS-获取自定义元数据(Java SDK):返回结果说明

返回结果说明表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 参数解释：对象数据流。默认取值：无

对象存储服务 OBS 下载对象(Java SDK)

对象存储服务 OBS-获取自定义元数据(Java SDK):接口约束

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

对象存储服务 OBS 下载对象(Java SDK)

对象存储服务 OBS-异步下载

异步下载开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。您可以通过ObsClient.BeginGetObject和ObsClient.EndGetObject，进行异步下载对象。本示例用于异步下载桶名为“bucketname”里，名称为“objectname”的对象。示例代码如下： // 初始化配置参数 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); // 异步下载对象 try { GetObjectRequest request = new GetObjectRequest() { BucketName = "bucketname", ObjectKey = "objectname", }; client.BeginGetObject(request, delegate(IAsyncResult ar){ try { using (GetObjectResponse response = client.EndGetObject(ar)) { string dest = "savepath"; if (!File.Exists(dest)) { // 将对象的数据流写入文件中 response.WriteResponseStreamToFile(dest); } Console.WriteLine("Get object response: {0}", response.StatusCode); } } catch (ObsException ex) { Console.WriteLine("ErrorCode: {0}", ex.ErrorCode); Console.WriteLine("ErrorMessage: {0}", ex.ErrorMessage); } }, null); } catch (ObsException ex) { Console.WriteLine("Message: {0}", ex.Message); } 更多下载对象的信息，请参见下载对象。父主题：下载对象

对象存储服务 OBS 下载对象

对象存储服务 OBS-流式下载

流式下载以下代码展示了如何进行流式下载： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 流式下载 OBSGetObjectToDataRequest *request = [[OBSGetObjectToDataRequest alloc]initWithBucketName:@"bucketname" objectKey:@"objectname"]; // 下载进度 request.downloadProgressBlock = ^(int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite) { NSLog(@"%0.1f%%",(float)(totalBytesWritten)*100/(float)totalBytesExpectedToWrite); }; // 下载的数据 __block NSMutableData *objectData = [NSMutableData new]; request.onReceiveDataBlock = ^(NSData *data) { [objectData appendData:data]; }; // 下载结果 [client getObject:request completionHandler:^(OBSGetObjectResponse *response, NSError *error){ NSLog(@"%@",response); }] ; } 父主题：下载对象

对象存储服务 OBS 下载对象

对象存储服务 OBS-断点续传下载

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

对象存储服务 OBS 下载对象

对象存储服务 OBS-下载对象-流式下载(Go SDK):接口约束

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

对象存储服务 OBS 下载对象简介(Go SDK)

对象存储服务 OBS-下载对象-流式下载(Go SDK):请求参数说明

请求参数说明表1 请求参数列表参数名称参数类型是否必选描述 input *GetObjectInput 必选参数解释：流式下载请求参数，详见GetObjectInput。 extensions extensionOptions 可选参数解释：桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。表2 GetObjectInput 参数名称参数类型是否必选描述 Bucket string 必选参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无 Key string 必选参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无 ResponseCacheControl string 可选参数解释：指定OBS返回请求中Cache-Control头的值。指定Object被下载时的网页的缓存行为。默认取值：无 ResponseContentDisposition string 可选参数解释：指定OBS返回请求中Content-Disposition头的值。指定Object被下载时的名称。默认取值：无 ResponseContentEncoding string 可选参数解释：指定OBS返回请求中Content-Encoding头的值。指定Object被下载时的内容编码格式。默认取值：无 ResponseContentLanguage string 可选参数解释：指定OBS返回请求中Content-Language头的值。指定Object被下载时的内容语言格式。默认取值：无 ResponseContentType string 可选参数解释：指定OBS返回请求中Content-Type头的值。指定Object文件类型。默认取值：无 ResponseExpires string 可选参数解释：指定OBS返回请求中Expires头的值。指定Object被下载时的网页的缓存过期时间。默认取值：无 VersionId string 可选参数解释：对象的版本号，用于获取指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。取值范围：长度为32的字符串。默认取值：无，如果不设置则默认获取最新版本的对象。 ImageProcess string 可选参数解释：图片处理参数，描述针对对象的图片处理命令或处理样式。例如表示对图片依次进行缩放、旋转，取值：image/resize,m_fixed,w_100,h_100/rotate,90。取值范围：命令方式：image/命令参数。样式方式：style/样式名称。详细参数说明参见处理图片。默认取值：如果不输入处理命令，将返回原图。 RangeStart int64 可选参数解释：指定下载对象的起始位置。取值范围： 0~对象长度，单位：字节。默认取值： 0，即从对象的第一个字节开始下载。 RangeEnd int64 可选参数解释：指定下载对象的结束位置。取值范围：取值必须大于RangeStart。如果该值大于对象长度-1，实际仍取对象长度-1，单位为字节。默认取值：无 IfMatch string 可选参数解释：指定一个预设的Etag值，如果下载对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。取值范围：长度为32的字符串。默认取值：无 IfNoneMatch string 可选参数解释：指定一个预设的Etag值，如果下载对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。取值范围：长度为32的字符串。默认取值：无 IfModifiedSince time.Time 可选参数解释：如果对象在指定的时间后有修改，则返回对象内容，否则返回错误。约束限制：日期格式必须为ISO8601的格式。例如：2018-01-01T00:00:00.000Z，表示如果最后修改时间晚于2018-01-01T00:00:00.000Z则返回对象内容，否则返回错误。代码示例：time.Now().Add(time.Duration(24) * time.Hour)。默认取值：无 IfUnmodifiedSince time.Time 可选参数解释：如果对象在指定的时间后没有修改，则返回对象内容，否则返回错误。约束限制：日期格式必须为ISO8601的格式。例如：2018-01-01T00:00:00.000Z，表示如果最后修改时间早于2018-01-01T00:00:00.000Z则返回对象内容，否则返回错误。代码示例：time.Now().Add(time.Duration(24) * time.Hour)。默认取值：无 SseHeader SseCHeader 可选参数解释：服务端解密头信息，详见SseCHeader。约束限制：如果客户端的对象上传时，使用了客户提供的加密密钥进行服务端加密，当下载对象时，同样也必须在消息中提供密钥。表3 SseCHeader 参数名称参数类型是否必选描述 Encryption string 作为请求参数时必选参数解释：表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。取值范围：可选值：AES256，即选择SSE-C方式加密对象。默认取值：无 Key string 作为请求参数时必选参数解释： SSE-C方式下加密使用的密钥，该密钥用于加密对象。约束限制：该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= 默认取值：无 KeyMD5 string 作为请求参数时可选参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。约束限制：由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值：无

对象存储服务 OBS 下载对象简介(Go SDK)

对象存储服务 OBS-对象下载简介(Node.js SDK)

对象下载简介(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 OBS Node.js SDK提供了丰富的对象下载接口，可以通过以下方式下载对象：文本下载(Node.js SDK) 流式下载(Node.js SDK) 文件下载(Node.js SDK) 范围下载(Node.js SDK) 断点续传下载(Node.js SDK) 您可以通过ObsClient.getObject下载对象。父主题：下载对象(Node.js SDK)

对象存储服务 OBS 下载对象(Node.js SDK)

对象存储服务 OBS-对象下载:参数描述

参数描述字段名类型约束说明 option 请求桶的上下文，配置option 必选桶参数。 object_info obs_object_info * 必选对象名和版本号，非多版本对象，version设置为0。 get_conditions obs_get_conditions * 必选对象筛选条件和读取范围设置。 encryption_params server_side_encryption_params * 可选获取对象的解密设置。 handler obs_get_object_handler * 必选回调函数。 callback_data void * 可选回调数据。

对象存储服务 OBS 下载对象

对象存储服务 OBS-流式下载

流式下载开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。以下代码展示了如何进行流式下载： // 初始化配置参数 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); // 下载对象 try { GetObjectRequest request = new GetObjectRequest() { BucketName = "bucketname", ObjectKey = "objectname", }; using (GetObjectResponse response = client.GetObject(request)) { string dest = "savepath"; if (!File.Exists(dest)) { // 将对象的数据流写入文件中 response.WriteResponseStreamToFile(dest); } Console.WriteLine("Get object response: {0}", response.StatusCode); } } catch (ObsException ex) { Console.WriteLine("ErrorCode: {0}", ex.ErrorCode); Console.WriteLine("ErrorMessage: {0}", ex.ErrorMessage); } 响应结果GetObjectResponse中GetObjectResponse.OutputStream为响应流（System.IO.Stream类型），通过操作GetObjectResponse.OutputStream可将对象的内容读取到本地文件或者内存中；用户也可以调用OBS .NET SDK提供的GetObjectResponse.WriteResponseStreamToFile方法，将对象内容下载到本地文件中。 GetObjectResponse.OutputStream获取的响应流一定要调用GetObjectResponse.OutputStream.Close()显式关闭，否则可能造成资源泄露。父主题：下载对象

对象存储服务 OBS 下载对象

云服务器内容精选

下载对象

7*24

备案

专业服务

退订

建议反馈

售前咨询热线