华为云用户手册

代码示例 您可以通过New函数创建OBS客户端，永久访问密钥（AK/SK）创建OBS客户端示例代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 // 引入依赖包 import ( 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") // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 obsClient, err := obs.New(ak, sk, endPoint) if err == nil { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 携带代理proxy创建OBS客户端代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 // 引入依赖包 import ( "obs" ) func main() { //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 obsClient, err := obs.New(ak, sk, endPoint, obs.WithProxyUrl("https://username:password!@yourProxy")) if err == nil { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 临时访问密钥（AK/SK和SecurityToken）创建OBS客户端代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 // 引入依赖包 import ( 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 { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 您还可以通过配置系统环境变量的方式或者通过访问ECS服务器获取临时访问密钥的方式创建OBS客户端。 从环境变量中获取访问密钥创建OBS客户端的代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 // 引入依赖包 import ( 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.WithSecurityProviders(obs.NewEnvSecurityProvider("")) if err == nil { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 以上方式会从当前系统的环境变量中寻找访问密钥，需要对应在环境变量中定义OBS_ACCESS_KEY_ID、OBS_SECRET_ACCESS_KEY字段。同时如果采用临时访问密钥时，还需要在环境变量中定义OBS_SECURITY_TOKEN字段。 从ECS获取临时访问密钥创建OBS客户端的代码如下： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 // 引入依赖包 import ( 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.WithSecurityProviders(obs.NewEcsSecurityProvider(1)) if err == nil { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 当应用程序部署在ECS服务器上且该ECS绑定了相关委托项时，可以采用以上方式从ECS服务器上自动获取临时访问密钥。 使用链式方式从系统环境变量及ECS上获取访问密钥创建OBS客户端的代码如下： 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 // 引入依赖包 import ( 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.WithSecurityProviders(obs.NewEnvSecurityProvider(""), obs.NewEcsSecurityProvider(1)) ) if err == nil { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 以上初始化过程指定以链式的方式从环境变量和ECS中顺序获取访问密钥，并采用第一组成功获取到的访问密钥创建obsClient。 您的工程中可以有多个ObsClient，也可以只有一个ObsClient。 ObsClient是协程安全的，可在并发场景下使用。 ObsClient在调用ObsClient.close方法关闭后不能再次使用。 您可以通过调用WithHttpTransport传入自定义Transport实现指定单Host最大连接数的功能，示例代码如下： 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 // 引入依赖包 import ( "time" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) // 创建ObsClient结构体 var obsClient, err = obs.New(ak, sk, endpoint, obs.WithHttpTransport(transport)) 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" // 初始化自定义transport var maxIdleConns = 1000 var maxConnsPerHost = 1000 var idleConnTimeout = 30 var transport = &http.Transport{ MaxIdleConns: maxIdleConns, MaxIdleConnsPerHost: maxIdleConns, MaxConnsPerHost: maxConnsPerHost, IdleConnTimeout: time.Second * time.Duration(idleConnTimeout), } // 创建obsClient实例 // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint,obs.WithHttpTransport(transport)) if err == nil { // 使用访问OBS // 关闭obsClient obsClient.Close() } } 只有在Golang 1.11以上的版本中才支持在Transport结构中指定MaxConnsPerHost参数。 如果指定了自定义的Transport，则无法通过WithMaxConnections、WithProxyUrl等配置方法配置Transport相关的最大空闲连接数、代理配置等参数，对应参数应直接在自定义Transport中指定。

可用的configurer 您可通过configurer（obs命名空间中的私有类型）对ObsClient进行配置，可用的configurer见下表： 创建方式 描述 建议值 WithSslVerifyAndPemCerts(sslVerify bool, pemCerts []byte) 配置验证服务端证书的参数。默认为不验证。 N/A WithHeaderTimeout(headerTimeout int) 配置获取响应头的超时时间。默认为60秒。 [10，60] WithMaxConnections(maxIdleConns int) 配置允许最大HTTP空闲连接数。默认为1000。 N/A WithConnectTimeout(connectTimeout int) 配置建立HTTP/HTTPS连接的超时时间（单位：秒）。默认为60秒。 [10，60] WithSocketTimeout(socketTimeout int) 配置读写数据的超时时间（单位：秒）。默认为60秒。 [10，60] WithIdleConnTimeout(idleConnTimeout int) 配置空闲的HTTP连接在连接池中的超时时间（单位：秒）。默认为30秒。 默认 WithMaxRetryCount(maxRetryCount int) 配置HTTP/HTTPS连接异常时的请求重试次数。默认为3次。 [1，5] WithProxyUrl(proxyUrl string) 配置HTTP代理。 N/A WithHttpTransport(transport *http.Transport) 配置自定义的Transport。 默认 WithRequestContext(ctx context.Context) 配置每次HTTP请求的上下文。 N/A WithMaxRedirectCount(maxRedirectCount int) 配置HTTP/HTTPS请求重定向的最大次数。默认为3次。 [1，5] WithSecurityToken(securityToken string) 配置临时访问密钥中的SecurityToken N/A 建议值为N/A的表示需要根据实际情况进行设置。 如网络状况不佳，建议增大WithConnectTimeout和WithSocketTimeout的值。

参数描述 字段名 类型 约束 说明 ak string 必选 访问密钥中的AK。 sk string 必选 访问密钥中的SK。 endpoint string 必选 连接OBS的服务地址。包含协议类型、域名（或IP）、端口号。示例：https://your-endpoint:443。（出于安全性考虑，建议使用https协议） 您可以从这里查看OBS当前开通的服务地址。 securityToken string 可选 临时访问密钥中的SecurityToken。 configurers configurer（obs包中的私有类型） 可选 一组用于配置ObsClient的参数，可进行连接超时时间、最大重试次数、最大连接数等配置。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用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对象的ACL权限控制列表信息 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 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.GetObjectAclInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 获取对象ACL output, err := obsClient.GetObjectAcl(input) if err == nil { fmt.Printf("Get object(%s)'s acl successful with bucket(%s)!\n", input.Key, input.Bucket) fmt.Printf("Owner.ID:%s\n", output.Owner.ID) for index, grant := range output.Grants { fmt.Printf("Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s\n", index, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission) } return } fmt.Printf("Get object(%s)'s acl fail with bucket(%s)!\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) } } 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 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.GetObjectAclInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 获取对象ACL output, err := obsClient.GetObjectAcl(input) if err == nil { fmt.Printf("Get object(%s)'s acl successful with bucket(%s)!\n", input.Key, input.Bucket) fmt.Printf("Owner.ID:%s\n", output.Owner.ID) for index, grant := range output.Grants { fmt.Printf("Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s\n", index, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission) } return } fmt.Printf("Get object(%s)'s acl fail with bucket(%s)!\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) } }

返回结果说明 表3 返回结果 参数名称 参数类型 描述 output *GetObjectAclOutput 参数解释： 接口返回信息，GetObjectAclOutput。 err error 参数解释： 接口返回错误信息。 表4 GetObjectAclOutput 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无 VersionId string 参数解释： 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 取值范围： 长度为32的字符串。 默认取值： 无 Owner Owner 参数解释： 对象的所有者账号户ID，详见Owner。 约束限制： Owner和Grants必须配套使用，且与ACL互斥。 Grants []Grant 参数解释： 被授权用户权限信息，详livered见Grant。 默认取值： 无 表5 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID? 默认取值： 无 表6 Grant 参数名称 参数类型 是否必选 描述 Grantee Grantee 作为请求参数时必选 参数解释： 被授权用户相关信息，详见Grantee。 Permission PermissionType 作为请求参数时必选 参数解释： 被授予的权限。 取值范围： 权限取值范围详见PermissionType。 默认取值： 无 表7 Grantee 参数名称 参数类型 是否必选 描述 Type GranteeType 作为请求参数时必选 参数解释： 被授权用户的类型，详见GranteeType。 ID string 作为请求参数时，如果Type为用户类型则必选。 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID? 默认取值： 无 DisplayName string 作为请求参数时可选 参数解释： 被授权用户的账号名。 约束限制： 不支持中文。 只能以字母开头。 长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 URI GroupUriType 作为请求参数时，如果Type为用户组类型则必选。 参数解释： 被授权的用户组。 取值范围： 授权用户组取值范围详见GroupUriType。 默认取值： 无 表8 PermissionType 常量名 原始值 说明 PermissionRead READ 读权限。 PermissionWrite WRITE 写权限。 PermissionReadAcp READ_ACP 读取ACL配置的权限。 PermissionWriteAcp WRITE_ACP 修改ACL配置的权限。 PermissionFullControl FULL_CONTROL 完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。 表9 GranteeType 常量名 原始值 说明 GranteeGroup Group 用户组。 GranteeUser CanonicalUser 单个用户。 表10 GroupUriType 常量名 原始值 说明 GroupAllUsers AllUsers 所有用户。

接口约束 您必须是桶拥有者或拥有获取对象ACL的权限，才能获取对象ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObjectAcl权限，如果使用桶策略则需授予GetObjectAcl权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 用户必须拥有对指定对象读ACP(access control policy)的权限，才能执行获取对象ACL的操作。

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input *GetObjectAclInput 必选 参数解释： 获取对象ACL请求参数，详情参考GetObjectAclInput。 extensions extensionOptions 可选 参数解释： 拓展配置项。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。 表2 GetObjectAclInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 桶名。 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 VersionId string 可选 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 默认值：无

代码示例 本示例用于设置名为examplebucket桶的自定义域名为www.example.com 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 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.SetBucketCustomDomainInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定桶的自定义域名，此处以www.example.com为例 input.CustomDomain = "www.example.com" // 设置桶的自定义域名 output, err := obsClient.SetBucketCustomDomain(input) if err == nil { fmt.Printf("Set bucket(%s)'s customdomain successful!\n", input.Bucket) fmt.Printf("RequestId:%s\n", output.RequestId) return } fmt.Printf("Set bucket(%s)'s customdomain 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) } }

返回结果说明 表3 返回结果列表 参数名称 参数类型 描述 output *BaseModel 参数解释： 接口返回信息，详情参考BaseModel。 err error 参数解释： 接口返回错误信息。 表4 BaseModel 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input *SetBucketCustomDomainInput 必选 参数解释： 设置桶的自定义域名参数，详见SetBucketCustomDomainInput。 extensions extensionOptions 可选 参数解释： 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。 表2 SetBucketCustomDomainInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 CustomDomain string 必选 参数解释： 需要设置的自定义域名。 约束限制： 必须满足域名规则。 默认取值： 最长256字节。 默认取值： 无。

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

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

代码示例 本示例用于获取名为examplebucket桶下的版本对象列表，其中列举的是以test/ 开头的所有对象中的按照字典顺序的最多前100个对象，并且是从起始位置test/test2（该对象的版本号是G001117FCE89978B0000401205D5DC9A，如果没有匹配，则忽略该参数）开始列举。 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 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.ListVersionsInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定列举对象前缀，此处以“test/”前缀为例，满足指定前缀的对象会被列举。 input.Prefix = "test/" // 指定返回的最大对象数，此处以 100 为例，返回的对象列表将是按照字典顺序的最多前max-keys个对象，默认值为1000。 input.MaxKeys = 100 // 指定列举版本对象的起始位置，此处以“test/test2”为例 input.KeyMarker = "test/test2" // 与KeyMarker配合使用，如果KeyMarker没有对应的VersionIdMarker ，则该参数忽略 input.VersionIdMarker = "G001117FCE89978B0000401205D5DC9A" // 指定编码方式，此处以“url”为例，如果列举对象中存在特殊字符，则该参数必传 input.EncodingType = "url" // 列举桶内版本对象 output, err := obsClient.ListVersions(input) if err == nil { fmt.Printf("List version objects under the bucket(%s) successful!\n", input.Bucket) fmt.Printf("RequestId:%s\n", output.RequestId) for index, val := range output.Versions { fmt.Printf("Version[%d]-OwnerId:%s, ETag:%s, Key:%s, VersionId:%s, LastModified:%s, Size:%d\n", index, val.Owner.ID, val.ETag, val.Key, val.VersionId, val.LastModified, val.Size) } for index, val := range output.DeleteMarkers { fmt.Printf("DeleteMarker[%d]-OwnerId:%s, Key:%s, VersionId:%s, LastModified:%s\n", index, val.Owner.ID, val.Key, val.VersionId, val.LastModified) } return } fmt.Printf("List version 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) } }

返回结果说明 表4 返回结果 参数名称 参数类型 描述 output *CopyPartOutput type CopyPartOutput struct 参数解释： 接口返回信息。详情参见CopyPartOutput。 err error 参数解释： 接口返回错误信息。 表5 CopyPartOutput 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无 ETag string 参数解释： 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 LastModified time.Time 参数解释： 目标段的最近一次修改时间（UTC时间）。 约束限制： 日期格式必须为ISO8601的格式。 例如：2018-01-01T00:00:00.000Z，表示最后一次修改时间为2018-01-01T00:00:00.000Z。 代码示例：time.Now().Add(time.Duration(24) * time.Hour) 默认取值： 无 SseHeader SseCHeader type SseCHeader struct 或 SseKmsHeader type SseKmsHeader struct 参数解释： 服务端加密头信息。SSE-C加密方式详情参见SseCHeader，SSE-KMS加密方式详情参见SseKmsHeader。 PartNumber int 参数解释： 段号。 取值范围： 取值范围是[1,10000]的非负整数。 默认取值： 无 表6 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== 默认取值： 无 表7 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，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。

代码样例 本示例用于复制源桶（sourcebucketname）下对象（example/sourceobjectname）的段到目标桶（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 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.CopyPartInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定对象，此处以 example/objectname 为例。 input.Key = "example/objectname" // 指定复制源桶名，此处以sourcebucketname为例。 input.CopySourceBucket = "sourcebucketname" // 指定复制源桶名下的指定源对象名，此处以example/sourceobjectname为例。 input.CopySourceKey = "example/sourceobjectname" // 指定上传段的段号，此处以1为例。 input.PartNumber = 1 // 复制段 output, err := obsClient.CopyPart(input) if err == nil { fmt.Printf("Copy part(bucket:%s, object: %s) successful from bucket:%s's object: %s!\n", input.Bucket, input.Key, input.CopySourceBucket, input.CopySourceKey) fmt.Printf("ETag:%s, LastModified:%s\n", output.ETag, output.LastModified) return } fmt.Printf("Copy part(bucket:%s, object: %s) fail from bucket:%s's object: %s!\n", input.Bucket, input.Key, input.CopySourceBucket, input.CopySourceKey) 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 *CopyPartInput 必选 参数解释： 复制段请求参数。详情参见CopyPartInput。 extensions extensionOptions 可选 参数解释： 拓展配置项。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。 表2 CopyPartInput 参数名称 参数类型 是否必选 描述 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的字符串。 默认取值： 无 PartNumber int 必选 参数解释： 段号。 取值范围： 取值范围是[1,10000]的非负整数。 默认取值： 无 UploadId string 必选 参数解释： 分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8 取值范围： 长度为32的字符串。 默认取值： 无 CopySourceBucket string 必选 参数解释： 源桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 CopySourceKey string 必选 参数解释： 源对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 CopySourceRangeStart int64 可选 参数解释： 指定复制源对象的起始位置。 取值范围： 非负整数，单位为字节。 默认取值： 0 CopySourceRangeEnd int64 可选 参数解释： 指定复制源对象的结束位置。 约束限制： 取值必须大于RangeStart，如果该值大于对象长度-1，实际仍取对象长度-1，单位为字节。 取值范围： 非负整数，单位为字节。 默认取值： 无 SseHeader SseCHeader 可选 参数解释： 服务端加密头信息，用于加密目标对象。详情参见SseCHeader。 约束限制： 如果客户端的对象上传时，使用了客户提供的加密密钥进行服务端加密，当下载对象时，同样也必须在消息中提供密钥。 SourceSseHeader 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== 默认取值： 无

功能说明 初始化分段上传任务后，通过分段上传任务的ID，复制段到指定桶中。 多段上传任务创建后，用户可以通过指定多段上传任务号，为特定的任务上传段。添加段的方式还包括调用段拷贝接口。允许客户将已上传对象的一部分或全部拷贝为段。 将源对象object拷贝为一个段part1，如果在拷贝操作之前part1已经存在，拷贝操作执行之后，旧的段数据part1会被新拷贝的段数据覆盖。拷贝成功后，只能列举到最新的段part1，旧的段数据将会被删除。因此在使用拷贝段接口时请确保目标段不存在或者已无价值，避免因拷贝段导致数据误删除。拷贝过程中源对象object无任何变化。

接口约束 您必须是桶拥有者或拥有复制段的权限，才能复制段。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 拷贝段的结果不能仅根据HTTP返回头域中的status_code来判断请求是否成功，头域中status_code返回200时表示服务端已经收到请求，且开始处理拷贝段请求。拷贝是否成功会在响应消息的body中，只有body体中有ETag标签才表示成功，否则表示拷贝失败。

代码示例 本示例用于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) } }

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

可用的拓展请求头 创建方式 说明 WithTrafficLimitHeader(trafficLimit int64) 配置在请求中携带单链接限速头域。目前仅支持 GetObject 方法。 取值范围：819200 ~ 838860800，单位：bit/s。 表1 PayerType 常量名 原始值 说明 BucketOwnerPayer BucketOwner 表示桶拥有者支付所有费用。 RequesterPayer Requester 表示请求者支付流量和请求次数费用，桶拥有者支付存储费用。

分段相关接口说明(Go SDK) 对于较大文件上传，可以切分成段上传。用户可以在如下的应用场景内（但不仅限于此），使用分段上传的模式： 上传超过100MB大小的文件。 网络条件较差，和OBS服务端之间的链接经常断开。 上传前无法确定将要上传文件的大小。 分段上传分为如下3个步骤： 初始化分段上传任务（ObsClient.InitiateMultipartUpload）。 逐个或并行上传段（ObsClient.UploadPart）。 合并段（ObsClient.CompleteMultipartUpload）或取消分段上传任务(ObsClient.AbortMultipartUpload)。 以下代码简单展示了分段上传的各个步骤： 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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 // 引入依赖包 import ( "fmt" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) //推荐通过环境变量获取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, _:= obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/) func main() { var uploadId = "" var eTag1 = "" var eTag2 = "" var partNumber1= 1 var partNumber2= 2 // 初始化分段上传任务 inputInit := &obs.InitiateMultipartUploadInput{} inputInit.Bucket = "bucketname" inputInit.Key = "objectkey" outputInit, err := obsClient.InitiateMultipartUpload(inputInit) if err == nil { fmt.Printf("RequestId:%s\n", outputInit.RequestId) fmt.Printf("UploadId:%s\n", outputInit.UploadId) uploadId = outputInit.UploadId } else { if obsError, ok := err.(obs.ObsError); ok { fmt.Println(obsError.Code) fmt.Println(obsError.Message) } else { fmt.Println(err) } } // 上传段 inputUploadPart := &obs.UploadPartInput{} inputUploadPart.Bucket = "bucketname" inputUploadPart.Key = "objectkey" inputUploadPart.UploadId = uploadId inputUploadPart.PartNumber = partNumber1 inputUploadPart.SourceFile = "localFilePath" outputUploadPart, err := obsClient.UploadPart(inputUploadPart) if err == nil { fmt.Printf("RequestId:%s\n", outputUploadPart.RequestId) fmt.Printf("ETag:%s\n", outputUploadPart.ETag) eTag1 = outputUploadPart.ETag } else { if obsError, ok := err.(obs.ObsError); ok { fmt.Println(obsError.Code) fmt.Println(obsError.Message) } else { fmt.Println(err) } } inputUploadPart = &obs.UploadPartInput{} inputUploadPart.Bucket = "bucketname" inputUploadPart.Key = "objectkey" inputUploadPart.UploadId = uploadId inputUploadPart.PartNumber = partNumber2 inputUploadPart.SourceFile = "localFilePath" outputUploadPart, err = obsClient.UploadPart(inputUploadPart) if err == nil { fmt.Printf("RequestId:%s\n", outputUploadPart.RequestId) fmt.Printf("ETag:%s\n", outputUploadPart.ETag) eTag2 = outputUploadPart.ETag } else { if obsError, ok := err.(obs.ObsError); ok { fmt.Println(obsError.Code) fmt.Println(obsError.Message) } else { fmt.Println(err) } } // 合并段 inputCompleteMultipart := &obs.CompleteMultipartUploadInput{} inputCompleteMultipart.Bucket = "bucketname" inputCompleteMultipart.Key = "objectkey" inputCompleteMultipart.UploadId = uploadId inputCompleteMultipart.Parts = []obs.Part{ obs.Part{PartNumber: partNumber1, ETag: eTag1}, obs.Part{PartNumber: partNumber2, ETag: eTag2}, } outputCompleteMultipart, err := obsClient.CompleteMultipartUpload(inputCompleteMultipart) if err == nil { fmt.Printf("RequestId:%s\n", outputCompleteMultipart.RequestId) fmt.Printf("Location:%s, Bucket:%s, Key:%s, ETag:%s\n", outputCompleteMultipart.Location, outputCompleteMultipart.Bucket, outputCompleteMultipart.Key, outputCompleteMultipart.ETag) } else { if obsError, ok := err.(obs.ObsError); ok { fmt.Println(obsError.Code) fmt.Println(obsError.Message) } else { fmt.Println(err) } } } 其他分段操作请参考： 分段上传-列举分段上传任务 分段上传-列举已上传的段 分段上传-复制段 父主题： 多段相关接口(Go SDK)

返回结果说明 表7 返回结果 参数名称 参数类型 描述 output *InitiateMultipartUploadOutput 参数解释： 接口返回信息。详情参见InitiateMultipartUploadOutput。 err error 参数解释： 接口返回错误信息。 表8 InitiateMultipartUploadOutput 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无 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的字符串。 默认取值： 无 UploadId string 参数解释： 分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8 取值范围： 长度大于0且不超过32的字符串。 默认取值： 无 SseHeader SseCHeader 或 SseKmsHeader 参数解释： 服务端加密头信息。SSE-C加密方式详情参见SseCHeader，SSE-KMS加密方式详情参见SseKmsHeader。 EncodingType string 参数解释： 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 取值范围： 可选值为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，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。

代码示例 本示例用于初始化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 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.InitiateMultipartUploadInput{} // 指定存储桶名称 input.Bucket = "examplebucket" // 指定对象名，此处以 example/objectname 为例。 input.Key = "example/objectname" // 初始化上传段任务 output, err := obsClient.InitiateMultipartUpload(input) if err == nil { fmt.Printf("Initiate multipart upload successful with bucket(%s) and object(%s)!\n", input.Bucket, input.Key) fmt.Printf("UploadId:%s\n", output.UploadId) return } fmt.Printf("Initiate multipart upload fail with bucket(%s) and object(%s)!\n", input.Bucket, input.Key) 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) } }

功能说明 使用多段上传特性时，用户必须首先调用创建多段上传任务接口创建任务，系统会给用户返回一个全局唯一的多段上传任务号，作为任务标识。后续用户可以根据这个标识发起相关的请求，如：上传段、合并段、列举段等。创建多段上传任务不影响已有的同名对象；同一个对象可以同时存在多个多段上传任务；每个多段上传任务在初始化时可以附加消息头信息，包括acl、用户自定义元数据和通用的HTTP消息头contentType、contentEncoding等，这些附加的消息头信息将先记录在多段上传任务元数据中。 在指定桶中初始化分段上传任务。

接口约束 您必须是桶拥有者或拥有初始化分段上传任务的权限，才能初始化分段上传任务。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 初始化上传段任务并上传一个或多个段之后，您必须合并段或取消多段上传任务，才能停止收取已上传的段的存储费用。仅当在合并段或取消多段上传任务之后，OBS才释放段存储并停止向您收取段存储费用。

代码示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 // 引入依赖包 import ( obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { // 设置日志文件存放的路径 var logFullPath string = "./logs/OBS-SDK.log" // 设置每个日志文件的大小，单位：字节 var maxLogSize int64 = 1024 * 1024 * 10 // 设置保留日志文件的个数 var backups int = 10 // 设置日志的级别 var level = obs.LEVEL_INFO // 设置是否打印日志到控制台 var logToConsole bool = false // 开启日志 obs.InitLog(logFullPath, maxLogSize, backups, level, logToConsole) // 关闭日志，同步缓存 obs.CloseLog() } 日志功能默认是关闭的，需要主动开启。 您可以从日志分析章节获取更多关于SDK日志的信息。 日志默认首先写入缓存（累积一定量后再写入文件），程序退出前调用obs.CloseLog()可同步缓存中的日志内容到日志文件。

参数描述 参数名称 参数类型 是否必选 描述 logFullPath string 必选 日志文件的全路径。 maxLogSize int64 必选 日志文件大小，单位：字节。 backups int 必选 最大可保留的日志文件个数。 level Level 必选 日志级别。 logToConsole bool 必选 是否将日志打印到控制台。 取值范围：true/false true: 表示将日志打印到控制台 false: 表示将日志不打印到控制台 默认值：false 表1 Level 常量名 原始值 说明 LEVEL_OFF 500 关闭级别，如果设置为这个级别，日志打印功能将被关闭。 LEVEL_ERROR 400 错误级别，如果设置为这个级别，仅打印发生异常时的错误信息。 LEVEL_WARN 300 告警级别，如果设置为这个级别，除了打印错误级别的信息外，还将打印一些关键事件的信息。 LEVEL_INFO 200 信息级别，如果设置为这个级别，除了打印告警级别的信息外，还将打印HTTP/HTTPS请求的耗时时间，ObsClient接口的耗时时间等。 LEVEL_DEBUG 100 调试级别，如果设置为这个级别，除了打印INFO级别的信息外，还将打印每次HTTP/HTTPS请求和响应的头信息、鉴权算法计算出的stringToSign信息等。