初始化
更新时间:2020-04-23
确认Endpoint
在确认您使用SDK时配置的Endpoint时,可先阅读开发人员指南中关于 BBC访问域名的部分, 理解Endpoint相关的概念。百度云目前开放了多区域支持,请参考区域选择说明。
获取密钥
要使用百度云BBC,您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。 AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问BBC做签名验证。
可以通过如下步骤获得并了解您的AK/SK信息:
新建BBC Client
BBC Client是BBC服务的客户端,为开发者与BBC服务进行交互提供了一系列的方法。
使用AK/SK新建BBC Client
通过AK/SK方式访问BBC,用户可以参考如下代码新建一个Bbc Client:
import "github.com/baidubce/bce-sdk-go/services/bbc"
func main() {
// 用户的Access Key ID和Secret Access Key
ACCESS_KEY_ID, SECRET_ACCESS_KEY := <your-access-key-id>, <your-secret-access-key>
// 用户指定的Endpoint
ENDPOINT := <domain-name>
// 初始化一个BBClient
bbcClient, err := bbc.NewClient(AK, SK, ENDPOINT)
}
在上面代码中,ACCESS_KEY_ID
对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY
对应控制台中的“Access Key Secret”,
获取方式请参考获取AKSK。
第三个参数ENDPOINT
支持用户自己指定域名,如果设置为空字符串,会使用默认域名作为BBC的服务地址。
注意:
ENDPOINT
参数需要用指定区域的域名来进行定义,如服务所在区域为北京,则为bbc.bj.baidubce.com
。
配置HTTPS协议访问BBC
BBC支持HTTPS传输协议,您可以通过在创建BBC Client对象时指定的Endpoint中指明HTTPS的方式,在BBC GO SDK中使用HTTPS访问BBC服务:
import "github.com/baidubce/bce-sdk-go/services/bbc"
ENDPOINT := "https://bbc.bj.baidubce.com" //指明使用HTTPS协议
AK, SK := <your-access-key-id>, <your-secret-access-key>
bbcClient, _ := bbc.NewClient(AK, SK, ENDPOINT)
设置网络参数
用户可以通过如下的示例代码进行网络参数的设置:
import "github.com/baidubce/bce-sdk-go/services/bbc"
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bbc.bj.baidubce.com"
client, _ := bbc.NewClient(AK, SK, ENDPOINT)
// 配置不进行重试,默认为Back Off重试
client.Config.Retry = bce.NewNoRetryPolicy()
// 配置连接超时时间为30秒
client.Config.ConnectionTimeoutInMillis = 30 * 1000
配置生成签名字符串选项
// import "github.com/baidubce/bce-sdk-go/services/bbc"
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bbc.bj.baidubce.com"
client, _ := bbc.NewClient(AK, SK, ENDPOINT)
// 配置签名使用的HTTP请求头为`Host`
headersToSign := map[string]struct{}{"Host": struct{}{}}
client.Config.SignOption.HeadersToSign = HeadersToSign
// 配置签名的有效期为30秒
client.Config.SignOption.ExpireSeconds = 30
参数说明
用户使用GO SDK访问BBC时,创建的BBC Client对象的Config
字段支持的所有参数如下表所示:
配置项名称 | 类型 | 含义 |
---|---|---|
Endpoint | string | 请求服务的域名 |
ProxyUrl | string | 客户端请求的代理地址 |
Region | string | 请求资源的区域 |
UserAgent | string | 用户名称,HTTP请求的User-Agent头 |
Credentials | *auth.BceCredentials | 请求的鉴权对象,分为普通AK/SK与STS两种 |
SignOption | *auth.SignOptions | 认证字符串签名选项 |
Retry | RetryPolicy | 连接重试策略 |
ConnectionTimeoutInMillis | int | 连接超时时间,单位毫秒,默认20分钟 |
说明:
Credentials
字段使用auth.NewBceCredentials
与auth.NewSessionBceCredentials
函数创建,默认使用前者. 后者为使用STS鉴权时使用SignOption
字段为生成签名字符串时的选项,详见下表说明:
名称 | 类型 | 含义 |
---|---|---|
HeadersToSign | map[string]struct{} | 生成签名字符串时使用的HTTP头 |
Timestamp | int64 | 生成的签名字符串中使用的时间戳,默认使用请求发送时的值 |
ExpireSeconds | int | 签名字符串的有效期 |
其中,HeadersToSign默认为`Host`,`Content-Type`,`Content-Length`,`Content-MD5`;TimeStamp一般为零值,表示使用调用生成认证字符串时的时间戳,用户一般不应该明确指定该字段的值;ExpireSeconds默认为1800秒即30分钟。
Retry
字段指定重试策略,目前支持两种:NoRetryPolicy
和BackOffRetryPolicy
。默认使用后者,该重试策略是指定最大重试次数、最长重试时间和重试基数,按照重试基数乘以2的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。