初始化

确认Endpoint

在确认您使用SDK时配置的Endpoint时,可先阅读开发人员指南中关于BOS访问域名的部分,理解Endpoint相关的概念。百度云目前开放了多区域支持,请参考区域选择说明

目前支持“华北-北京”、“华南-广州”和“华东-苏州”三个区域。北京区域:http://bj.bcebos.com,广州区域:http://gz.bcebos.com,苏州区域:http://su.bcebos.com。对应信息为:

访问区域对应Endpoint
BJbj.bcebos.com
GZgz.bcebos.com
SUsu.bcebos.com

获取密钥

要使用百度云BOS,您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问BOS做签名验证。

可以通过如下步骤获得并了解您的AK/SK信息:

注册百度云账号

创建AK/SK

新建BOS Client

BOS Client是BOS服务的客户端,为开发者与BOS服务进行交互提供了一系列的方法。

使用AK/SK新建BOS Client

通过AK/SK方式访问BOS,用户可以参考如下代码新建一个BOS Client:

  1. import (
  2. "github.com/baidubce/bce-sdk-go/services/bos"
  3. )
  4. func main() {
  5. // 用户的Access Key ID和Secret Access Key
  6. ACCESS_KEY_ID, SECRET_ACCESS_KEY := <ak>, <sk>
  7. // 用户指定的Endpoint
  8. ENDPOINT := <domain-name>
  9. // 初始化一个BosClient
  10. bosClient, err := bos.NewClient(AK, SK, ENDPOINT)
  11. }

在上面代码中,ACCESS_KEY_ID对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 管理ACCESSKEY》。第三个参数ENDPOINT支持用户自己指定域名,如果设置为空字符串,会使用默认域名作为BOS的服务地址。

注意:ENDPOINT参数需要用指定区域的域名来进行定义,如服务所在区域为北京,则为http://bj.bcebos.com

使用STS创建BOS Client

申请STS token

BOS可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。

通过STS方式访问BOS,用户需要先通过STS的client申请一个认证字符串,申请方式可参见百度云STS使用介绍

用STS token新建BOS Client

申请好STS后,可将STS Token配置到BOS Client中,从而实现通过STS Token创建BOS Client。

代码示例

GO SDK实现了STS服务的接口,用户可以参考如下完整代码,实现申请STS Token和创建BOS Client对象:

  1. import (
  2. "fmt"
  3. "github.com/baidubce/bce-sdk-go/auth" //导入认证模块
  4. "github.com/baidubce/bce-sdk-go/services/bos" //导入BOS服务模块
  5. "github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
  6. )
  7. func main() {
  8. // 创建STS服务的Client对象,Endpoint使用默认值
  9. AK, SK := <your-access-key-id>, <your-secret-access-key>
  10. stsClient, err := sts.NewClient(AK, SK)
  11. if err != nil {
  12. fmt.Println("create sts client object :", err)
  13. return
  14. }
  15. // 获取临时认证token,有效期为60秒,ACL为空
  16. sts, err := stsClient.GetSessionToken(60, "")
  17. if err != nil {
  18. fmt.Println("get session token failed:", err)
  19. return
  20. }
  21. fmt.Println("GetSessionToken result:")
  22. fmt.Println(" accessKeyId:", sts.AccessKeyId)
  23. fmt.Println(" secretAccessKey:", sts.SecretAccessKey)
  24. fmt.Println(" sessionToken:", sts.SessionToken)
  25. fmt.Println(" createTime:", sts.CreateTime)
  26. fmt.Println(" expiration:", sts.Expiration)
  27. fmt.Println(" userId:", sts.UserId)
  28. // 使用申请的临时STS创建BOS服务的Client对象,Endpoint使用默认值
  29. bosClient, err := bos.NewClient(sts.AccessKeyId, sts.SecretAccessKey, "")
  30. if err != nil {
  31. fmt.Println("create bos client failed:", err)
  32. return
  33. }
  34. stsCredential, err := auth.NewSessionBceCredentials(
  35. sts.AccessKeyId,
  36. sts.SecretAccessKey,
  37. sts.SessionToken)
  38. if err != nil {
  39. fmt.Println("create sts credential object failed:", err)
  40. return
  41. }
  42. bosClient.Config.Credentials = stsCredential
  43. }
注意:目前使用STS配置BOS Client时,无论对应BOS服务的Endpoint在哪里,STS的Endpoint都需配置为http://sts.bj.baidubce.com。上述代码中创建STS对象时使用此默认值。

配置HTTPS协议访问BOS

BOS支持HTTPS传输协议,您可以通过在创建BOS Client对象时指定的Endpoint中指明HTTPS的方式,在BOS GO SDK中使用HTTPS访问BOS服务:

  1. // import "github.com/baidubce/bce-sdk-go/services/bos"
  2. ENDPOINT := "https://bj.bcebos.com" //指明使用HTTPS协议
  3. AK, SK := <your-access-key-id>, <your-secret-access-key>
  4. bosClient, _ := bos.NewClient(AK, SK, ENDPOINT)

配置BOS Client

如果用户需要配置BOS Client的一些细节的参数,可以在创建BOS Client对象之后,使用该对象的导出字段Config进行自定义配置,可以为客户端配置代理,最大连接数等参数。

使用代理

下面一段代码可以让客户端使用代理访问BOS服务:

  1. // import "github.com/baidubce/bce-sdk-go/services/bos"
  2. //创建BOS Client对象
  3. AK, SK := <your-access-key-id>, <your-secret-access-key>
  4. ENDPOINT := "bj.bcebos.com"
  5. client, _ := bos.NewClient(AK, SK, ENDPOINT)
  6. //代理使用本地的8080端口
  7. client.Config.ProxyUrl = "127.0.0.1:8080"

设置网络参数

用户可以通过如下的示例代码进行网络参数的设置:

  1. // import "github.com/baidubce/bce-sdk-go/services/bos"
  2. AK, SK := <your-access-key-id>, <your-secret-access-key>
  3. ENDPOINT := "bj.bcebos.com"
  4. client, _ := bos.NewClient(AK, SK, ENDPOINT)
  5. // 配置不进行重试,默认为Back Off重试
  6. client.Config.Retry = bce.NewNoRetryPolicy()
  7. // 配置连接超时时间为30秒
  8. client.Config.ConnectionTimeoutInMillis = 30 * 1000

配置生成签名字符串选项

  1. // import "github.com/baidubce/bce-sdk-go/services/bos"
  2. AK, SK := <your-access-key-id>, <your-secret-access-key>
  3. ENDPOINT := "bj.bcebos.com"
  4. client, _ := bos.NewClient(AK, SK, ENDPOINT)
  5. // 配置签名使用的HTTP请求头为`Host`
  6. headersToSign := map[string]struct{}{"Host": struct{}{}}
  7. client.Config.SignOption.HeadersToSign = HeadersToSign
  8. // 配置签名的有效期为30秒
  9. client.Config.SignOption.ExpireSeconds = 30

参数说明

用户使用GO SDK访问BOS时,创建的BOS Client对象的Config字段支持的所有参数如下表所示:

配置项名称类型含义
Endpointstring请求服务的域名
ProxyUrlstring客户端请求的代理地址
Regionstring请求资源的区域
UserAgentstring用户名称,HTTP请求的User-Agent头
Credentialsauth.BceCredentials请求的鉴权对象,分为普通AK/SK与STS两种
SignOptionauth.SignOptions认证字符串签名选项
RetryRetryPolicy连接重试策略
ConnectionTimeoutInMillisint连接超时时间,单位毫秒,默认20分钟

说明:

  • Credentials字段使用auth.NewBceCredentialsauth.NewSessionBceCredentials函数创建,默认使用前者,后者为使用STS鉴权时使用,详见“使用STS创建BOS Client”小节。
  • SignOption字段为生成签名字符串时的选项,详见下表说明: 名称 类型 含义 HeadersToSign map[string]struct{} 生成签名字符串时使用的HTTP头 Timestamp int64 生成的签名字符串中使用的时间戳,默认使用请求发送时的值 ExpireSeconds int 签名字符串的有效期 其中,HeadersToSign默认为HostContent-TypeContent-LengthContent-MD5;TimeStamp一般为零值,表示使用调用生成认证字符串时的时间戳,用户一般不应该明确指定该字段的值;ExpireSeconds默认为1800秒即30分钟。
  • Retry字段指定重试策略,目前支持两种:NoRetryPolicyBackOffRetryPolicy。默认使用后者,该重试策略是指定最大重试次数、最长重试时间和重试基数,按照重试基数乘以2的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。