华为云用户手册

接口约束 您必须是桶拥有者或拥有创建文件夹的权限，才能创建文件夹。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 创建文件夹本质上来说是创建了一个大小为0且对象名以“/”结尾的对象。 多级文件夹创建最后一级即可，比如src1/src2/src3/，创建src1/src2/src3/即可，无需创建src1/、src1/src2/。

代码示例 本示例用于在examplebucket桶中创建文件夹 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 package main import ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥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.PutObjectInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定文件夹，此处以 parent_directory 为例。 input.Key = "parent_directory/" // 流式上传本地文件 output, err := obsClient.PutObject(input) if err == nil { fmt.Printf("Put object(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) fmt.Printf("RequestId:%s, ETag:%s\n", output.RequestId, output.ETag) return } fmt.Printf("Put object(%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) } }

代码示例 本示例用于断点下载examplebucket桶中的example/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 package main import ( "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) } }

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

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

请求参数说明 表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== 默认取值： 无

代码示例 本示例用于examplebucket桶中的对象名称为example/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 package main import ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥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.GetObjectInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定下载对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 对图片依次进行缩放、旋转 input.ImageProcess = "image/resize,m_fixed,w_100,h_100/rotate,90" // 图片处理 output, err := obsClient.GetObject(input) if err == nil { // output.Body 必须关闭，否则会造成连接泄漏。 defer output.Body.Close() fmt.Printf("Get object(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) fmt.Printf("ContentType:%s\n", output.ContentType) 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("List objects under the bucket(%s) fail!\n", 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:object:PutObject权限，才能进行图片处理。相关授权操作可参见典型权限场景配置案例。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 所有的图片处理操作均不会修改原图。 归档存储不支持图片处理。 深度归档存储不支持图片处理。 处理后的图片直接返回浏览器展示，不会保存在OBS中，也不会占用存储空间，不会产生存储费用。图片处理只收取处理的费用。

请求参数说明 表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/commands 样式方式：style/stylename 详细参数说明参见处理图片。 默认取值： 如果不输入处理命令，将返回原图。 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== 默认取值： 无

功能说明 下载对象时，可以重写部分HTTP/HTTPS响应头信息。可重写的响应头信息见下表： 参数 作用 GetObjectInput.ResponseContentType 重写HTTP/HTTPS响应中的Content-Type GetObjectInput.ResponseContentLanguage 重写HTTP/HTTPS响应中的Content-Language GetObjectInput.ResponseExpires 重写HTTP/HTTPS响应中的Expires GetObjectInput.ResponseCacheControl 重写HTTP/HTTPS响应中的Cache-Control GetObjectInput.ResponseContentDisposition 重写HTTP/HTTPS响应中的Content-Disposition GetObjectInput.ResponseContentEncoding 重写HTTP/HTTPS响应中的Content-Encoding

代码示例 本示例用于下载对象时重写响应头ContentType为image/jpeg 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 package main import ( "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.GetObjectInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定下载对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 重写响应头，此处重写Content-Type为例 input.ResponseContentType = "image/jpeg" // 流式下载对象 output, err := obsClient.GetObject(input) if err == nil { // output.Body 在使用完毕后必须关闭，否则会造成连接泄漏。 defer output.Body.Close() fmt.Printf("Get object(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) // 获取重写的响应头 fmt.Printf("ContentType:%s\n", output.ContentType) return } fmt.Printf("List objects under the bucket(%s) fail!\n", 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) } }

代码示例 本示例用于限定条件下载examplebucket桶中的example/objectname对象，并且指定该文件的修改时间必须在"2022/12/31 00:00:00"后才能下载成功。 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 package main import ( "fmt" "os" "time" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥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.GetObjectInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定下载对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 定义IfModifiedSince时间 layout := "2006/01/02 15:04:05" t, err := time.Parse(layout, "2022/12/31 00:00:00") if err != nil { fmt.Printf("Parse time error, errMsg: %s", err.Error()) } // 如果下载对象在给定的日期之后存在修改，才会下载成功。否则返回不带消息主题的304响应。 input.IfModifiedSince = t // 下载对象 output, err := obsClient.GetObject(input) if err == nil { // output.Body 必须关闭，否则会造成连接泄漏。 defer output.Body.Close() fmt.Printf("Get object(%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("List objects under the bucket(%s) fail!\n", 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) } }

请求参数说明 表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== 默认取值： 无

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

请求参数说明 表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== 默认取值： 无

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。 如果指定的范围无效（比如开始位置、结束位置为负数，大于文件大小），则会返回整个对象。 可以利用范围下载并发下载大对象，详细代码示例请参考concurrent_download_object_sample。

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

请求参数说明 表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== 默认取值： 无

代码示例 本示例用于断点上传example/objectname对象到examplebucket桶中 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 package main import ( "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.UploadFileInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定上传对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 指定待上传的本地文件，此处以/tmp/objectname为例。 input.UploadFile = "/tmp/objectname" // 指定是否开启断点续传模式，此处以true为例。默认为False，表示不开启。 input.EnableCheckpoint = true // 指定分段大小，单位字节。此处以每段9M为例。 input.PartSize = 9 * 1024 * 1024 // 指定分段上传时的最大并发数，此处以并发数5为例 input.TaskNum = 5 // 断点续传上传对象 output, err := obsClient.UploadFile(input) if err == nil { fmt.Printf("Upload file(%s) under the bucket(%s) successful!\n", input.UploadFile, input.Bucket) fmt.Printf("ETag:%s\n", output.ETag) return } fmt.Printf("Upload file(%s) under the bucket(%s) fail!\n", input.UploadFile, 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) } }

返回结果说明 表7 返回结果 参数名称 参数类型 描述 output *CompleteMultipartUploadOutput 参数解释： 断点续传接口返回信息，详见CompleteMultipartUploadOutput。 err error 参数解释： 接口返回错误信息。 表8 CompleteMultipartUploadOutput 字段名称 参数类型 说明 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无 ETag string 参数解释： 对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 Bucket string 参数解释： 合并段所在的桶的桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Key string 参数解释： 合并段后得到的对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 Location string 参数解释： 合并段后得到的对象的url。 例如：https://example-Bucket.obs.regions.myhuaweicloud.com/example-Object 默认取值： 无 VersionId string 参数解释： 合并段后得到的对象版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 取值范围： 长度为32的字符串。 默认取值： 无 SseHeader SseCHeader 或 SseKmsHeader 参数解释： 服务端加密头信息，选择SSE-C加密方式，则详见SseCHeader，选择SSE-KMS加密方式，则详见SseKmsHeader。 EncodingType string 参数解释： 对响应中的部分元素进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符（特殊字符），需设置该参数为url编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。 表9 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== 默认取值： 无 表10 SseKmsHeader 参数名称 参数类型 是否必选 描述 Encryption string 作为请求参数时必选 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围： 可选值：kms，即选择SSE-KMS方式加密对象。 默认取值： 无 Key string 作为请求参数时可选 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？； key_id是从 数据加密 服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 断点续传上传接口传入的文件大小至少要100K以上。 使用SDK的断点续传接口时，必须开启断点续传选项后才能在进程再次进入时读取上一次上传的进度。

功能说明 对分段上传的封装和加强，解决上传大文件时由于网络不稳定或程序崩溃导致上传失败的问题。其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则返回错误信息提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。 您可以通过ObsClient.UploadFile进行断点续传上传。

代码示例 本示例用于追加上传examplebucket桶中的example/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 package main import ( "fmt" "os" "strings" 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.AppendObjectInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定追加上传对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 指定追加写位置。如果是首次上传时就必须指定position为0 input.Position = 0 // 指定待上传对象的数据流 input.Body = strings.NewReader("Hello OBS") // 追加上传对象 output, err := obsClient.AppendObject(input) if err == nil { fmt.Printf("Append object(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) fmt.Printf("ETag:%s, NextAppendPosition:%d\n", output.ETag, output.NextAppendPosition) return } fmt.Printf("Append objects under the bucket(%s) fail!\n", 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) } }

返回结果说明 表7 返回结果 参数名称 参数类型 描述 output *AppendObjectOutput 参数解释： 接口返回信息，详情参考AppendObjectOutput。 err error 参数解释： 接口返回错误信息。 表8 AppendObjectOutput 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无 VersionId string 参数解释： 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 取值范围： 长度为32的字符串 默认取值： 无 ETag string 参数解释： 对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 SseHeader SseCHeader 或 SseKmsHeader 参数解释： 服务端加密头信息，选择SSE-C加密方式，则详见SseCHeader，选择SSE-KMS加密方式。则详见SseKmsHeader。 NextAppendPosition int64 参数解释： 下一次追加上传请求应该提供的追加写位置（position）。 约束限制： 需要追加写的对象首次上传时就必须指定为0，下次追加需要填写的值为服务端本次上传成功返回消息的NextAppendPosition。 取值范围： 0~（263-1），单位：字节。 默认取值： 0 表9 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== 默认取值： 无 表10 SseKmsHeader 参数名称 参数类型 是否必选 描述 Encryption string 作为请求参数时必选 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围： 可选值：kms，即选择SSE-KMS方式加密对象。 默认取值： 无 Key string 作为请求参数时可选 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 用户上传的对象存储在桶中。用户必须对桶有WRITE权限，才可以在桶中上传对象。同一个桶中存储的对象名必须是唯一的。 每次追加上传都会更新该对象的最后修改时间。 服务端加密SSE-C方式，那么追加上传和初始化段一样，设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传也必须携带。 服务端加密SSE-KMS方式，有且只有第一次上传且桶内不存在同名对象时，才设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传不携带。 每次追加上传的长度不能超过对象长度上限5G的限制。 每个Appendable对象追加写次数最多为10000次。 如果对象存储类型为COLD（归档存储）或深度归档存储，则不能调用该接口。 如果桶设置了跨区域复制配置，则不能调用该接口。 并行文件系统不支持追加写对象。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 单次上传对象大小范围是[0, 5GB]。 如果需要上传超过5GB的大文件，需要通过多段操作来分段上传。

代码示例 本示例用于将本地localfile文件上传到examplebucket桶中的example/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 package main import ( "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.PutFileInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定上传对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 指定本地文件，此处以localfile为例 input.SourceFile = "localfile" // 文件上传 output, err := obsClient.PutFile(input) if err == nil { fmt.Printf("Put file(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) fmt.Printf("StorageClass:%s, ETag:%s\n", output.StorageClass, output.ETag) return } fmt.Printf("Put 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) } }

代码示例 本示例用于流式上传到examplebucket桶中的example/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 package main import ( "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.PutObjectInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定上传对象，此处以 example/objectname 为例。 input.Key = "example/objectname" fd, _ := os.Open("localfile") input.Body = fd // 流式上传本地文件 output, err := obsClient.PutObject(input) if err == nil { fmt.Printf("Put object(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket) fmt.Printf("StorageClass:%s, ETag:%s\n", output.StorageClass, output.ETag) return } fmt.Printf("Put object(%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) } }

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 单次上传对象大小范围是[0, 5GB]。 如果需要上传超过5GB的大文件，需要通过多段操作来分段上传。

上传对象简介(Go SDK) 在OBS中，用户操作的基本数据单元是对象。OBS Go SDK提供了丰富的对象上传接口，可以通过以下方式上传对象： 流式上传 文件上传 分段上传 断点续传上传 SDK支持上传0KB~5GB的对象。流式上传和文件上传的内容大小不能超过5GB；当上传较大文件时，请使用分段上传，分段上传每段内容大小不能超过5GB。 如果上传的对象权限设置为匿名用户读取权限，对象上传成功后，匿名用户可通过链接地址访问该对象数据。对象链接地址格式为：https://桶名. 域名 /文件夹目录层级/对象名。如果该对象存在于桶的根目录下，则链接地址将不需要有文件夹目录层级。 上传对象-流式上传(Go SDK) 上传对象-文件上传(Go SDK) 上传对象-追加上传(Go SDK) 上传对象-断点续传上传(Go SDK) 父主题： 对象相关接口(Go SDK)