云服务器内容精选

华为云首页用户手册

下载对象简介(Go SDK)

对象存储服务 OBS-下载对象-断点续传下载(Go SDK):请求参数说明

请求参数说明表1 请求参数列表参数名称参数类型是否必选描述 input *DownloadFileInput 必选参数解释：断点续传下载请求参数，详见DownloadFileInput。 extensions extensionOptions 可选参数解释：拓展配置项。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。表2 DownloadFileInput 参数名称参数类型是否必选描述 Bucket string 必选参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无 Key string 必选参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4. emyhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无 VersionId string 可选参数解释：对象的版本号，用于获取指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。取值范围：长度为32的字符串。默认取值：无，如果不设置则默认获取最新版本的对象。 DownloadFile string 可选参数解释：下载对象的本地文件全路径。默认取值：当该值为空时，默认为当前程序的运行目录。 PartSize int64 可选参数解释：分段大小。取值范围：大于0，小于对象大小，单位：字节。默认取值： 9437184，即每段9MB。 TaskNum int 可选参数解释：分段下载时的最大并发数。取值范围： (0, 文件大小/分段大小]，即大于0小于等于文件大小除以分段大小向上取整。默认取值： 1，即不设置则默认串行下载。 EnableCheckpoint bool 可选参数解释：是否开启断点续传模式。取值范围： true：开启断点续传模式。 false：关闭断点续传模式。默认取值： false CheckpointFile string 可选参数解释：记录下载进度文件的文件路径，只在断点续传模式下有效。默认取值：当该值为空时，默认与下载对象的本地文件路径同目录。 SseHeader SseCHeader 可选参数解释：服务端解密头信息，详见SseCHeader。 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)。默认取值：无表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-下载对象-断点续传下载(Go SDK):代码示例

代码示例本示例用于断点下载examplebucket桶中的example/objectname对象 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536373839404142434445464748495051 package mainimport ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs")func main() { //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。 // securityToken := os.Getenv("SecurityToken") // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } input := &obs.DownloadFileInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定下载对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 指定下载对象的本地文件全路径，此处以/tmp/objectname为例。当该值为空时，默认为当前程序的运行目录。 input.DownloadFile = "/tmp/objectname" // 指定是否开启断点续传模式，此处以true为例。默认为False，表示不开启。 input.EnableCheckpoint = true // 指定分段大小，单位字节。此处以每段9M为例。 input.PartSize = 9 * 1024 * 1024 // 指定分段下载时的最大并发数，此处以并发数5为例 input.TaskNum = 5 // 断点续传下载对象 output, err := obsClient.DownloadFile(input) if err == nil { fmt.Printf("Download file(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) fmt.Printf("StorageClass:%s, ETag:%s, ContentType:%s, ContentLength:%d, LastModified:%s\n", output.StorageClass, output.ETag, output.ContentType, output.ContentLength, output.LastModified) return } fmt.Printf("Download file(%s) under the bucket(%s) fail!\n", input.Key, input.Bucket) if obsError, ok := err.(obs.ObsError); ok { fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.") fmt.Println(obsError.Error()) } else { fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.") fmt.Println(err) }}

对象存储服务 OBS 下载对象简介(Go SDK)
对象存储服务 OBS-下载对象-断点续传下载(Go SDK):功能说明

功能说明当下载大对象到本地文件时，经常出现因网络不稳定或程序崩溃导致下载失败的情况。失败后再次重新下载不仅浪费资源，而且当网络不稳定时仍然有下载失败的风险。断点续传下载接口能有效地解决此类问题引起的下载失败，其原理是将待下载的对象分成若干个分段分别下载，并实时地将每段下载结果统一记录在checkpoint文件中，仅当所有分段都下载成功时返回下载成功的结果，否则返回错误信息提醒用户再次调用接口进行重新下载（重新下载时因为有checkpoint文件记录当前的下载进度，避免重新下载所有分段，从而节省资源提高效率）。您可以通过ObsClient.DownloadFile进行断点续传下载。

对象存储服务 OBS 下载对象简介(Go SDK)
对象存储服务 OBS-下载对象-断点续传下载(Go SDK):接口约束

接口约束您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。断点续传下载接口是利用范围下载特性实现的，是对范围下载的封装和加强。断点续传下载接口不仅能在失败重下时节省资源提高效率，还因其对分段进行并发下载的机制能加快下载速度，帮助用户快速完成下载业务；且其对用户透明，用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发下载的实现等内部细节。 EnableCheckpoint参数默认是False，代表不启用断点续传模式，此时断点续传下载接口退化成对范围下载的简单封装，不会产生checkpoint文件。 CheckpointFile参数仅在EnableCheckpoint参数为True时有效。

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