初始化
确认 Endpoint
在确认您使用 SDK 时配置的 Endpoint 时,可先阅读开发人员指南中关于 BCI服务域名 的部分,理解 Endpoint 相关的概念。百度云目前开放了多区域支持,请参考 区域选择说明。
目前支持“华北-北京”、“华南-广州”、“华东-苏州”、“华北-保定”和“华中-武汉”五个区域。对应信息为:
| 访问区域 | 对应 Endpoint | 协议 |
|---|---|---|
| 华北-北京 | bci.bj.baidubce.com |
HTTP and HTTPS |
| 华南-广州 | bci.gz.baidubce.com |
HTTP and HTTPS |
| 华东-苏州 | bci.su.baidubce.com |
HTTP and HTTPS |
| 华北-保定 | bci.bd.baidubce.com |
HTTP and HTTPS |
| 华中-武汉 | bci.fwh.baidubce.com |
HTTP and HTTPS |
使用 SDK 时,Endpoint 需要与实例或目标资源所在区域保持一致。建议优先使用 HTTPS 访问服务,例如资源位于北京区域时,可配置为 bci.bj.baidubce.com,也可直接配置为 https://bci.bj.baidubce.com。
获取密钥
要使用百度云 BCI,您需要拥有一个有效的 AK (Access Key ID) 和 SK (Secret Access Key) 用来进行签名认证。AK/SK 是由系统分配给用户的,均为字符串,用于标识用户,为访问 BCI 做签名验证。
可以通过如下步骤获得并了解您的 AK/SK 信息:
若您已有百度云账号,可直接进入 AK/SK 创建流程。创建成功后请立即保存 Secret Access Key;自 2025 年 5 月 15 日 起,Secret Access Key 仅在创建时提供一次明文,后续不再支持明文查询。为便于做最小权限控制,建议优先使用子用户的 AK/SK。
新建BCI Client
BCI Client是BCI服务的客户端,为开发者与BCI服务进行交互提供了一系列的方法。
使用 AK/SK 新建 BCI Client
通过 AK/SK 方式访问 BCI,用户可以参考如下代码新建一个 BCI Client:
1package main
2
3import (
4 "log"
5
6 "github.com/baidubce/bce-sdk-go/services/bci"
7)
8
9func main() {
10 // 用户的 Access Key ID 和 Secret Access Key
11 ACCESS_KEY_ID := "your-access-key-id"
12 SECRET_ACCESS_KEY := "your-secret-access-key"
13
14 // 用户指定的 Endpoint
15 ENDPOINT := "bci.bj.baidubce.com"
16
17 // 初始化一个 BCI Client
18 bciClient, err := bci.NewClient(ACCESS_KEY_ID, SECRET_ACCESS_KEY, ENDPOINT)
19 if err != nil {
20 log.Fatal(err)
21 }
22
23 _ = bciClient
24}
在上面代码中,ACCESS_KEY_ID 对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY 对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 如何获取AKSK》。第三个参数 ENDPOINT 支持用户自己指定域名,如果设置为空字符串,会使用默认域名作为 BCI 的服务地址。使用正确的 AK/SK 与区域 Endpoint 初始化后,即可继续调用 BCI 的实例列表等接口。
注意:
ENDPOINT参数需要用指定区域的域名来进行定义,如服务所在区域为北京,则为bci.bj.baidubce.com。
使用STS创建BCI Client
申请STS token
BCI可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。
通过STS方式访问BCI,用户需要先通过STS的client申请一个认证字符串。
用STS token新建BCI Client
申请好STS后,可将STS Token配置到BCI Client中,从而实现通过STS Token创建BCI Client。
代码示例
GO SDK实现了STS服务的接口,用户可以参考如下完整代码,实现申请STS Token和创建BCI Client对象:
1import (
2 "fmt"
3
4 "github.com/baidubce/bce-sdk-go/auth" //导入认证模块
5 "github.com/baidubce/bce-sdk-go/services/bci" //导入BCI服务模块
6 "github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
7)
8
9func main() {
10 // 创建STS服务的Client对象,Endpoint使用默认值
11 AK, SK := <your-access-key-id>, <your-secret-access-key>
12 stsClient, err := sts.NewClient(AK, SK)
13 if err != nil {
14 fmt.Println("create sts client object :", err)
15 return
16 }
17
18 // 获取临时认证token,有效期为60秒,ACL为空
19 stsObj, err := stsClient.GetSessionToken(60, "")
20 if err != nil {
21 fmt.Println("get session token failed:", err)
22 return
23 }
24 fmt.Println("GetSessionToken result:")
25 fmt.Println(" accessKeyId:", stsObj.AccessKeyId)
26 fmt.Println(" secretAccessKey:", stsObj.SecretAccessKey)
27 fmt.Println(" sessionToken:", stsObj.SessionToken)
28 fmt.Println(" createTime:", stsObj.CreateTime)
29 fmt.Println(" expiration:", stsObj.Expiration)
30 fmt.Println(" userId:", stsObj.UserId)
31
32 // 使用申请的临时STS创建BCI服务的Client对象,Endpoint使用默认值
33 bciClient, err := bci.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "bci.bj.baidubce.com")
34 if err != nil {
35 fmt.Println("create bci client failed:", err)
36 return
37 }
38 stsCredential, err := auth.NewSessionBceCredentials(
39 stsObj.AccessKeyId,
40 stsObj.SecretAccessKey,
41 stsObj.SessionToken)
42 if err != nil {
43 fmt.Println("create sts credential object failed:", err)
44 return
45 }
46 bciClient.Config.Credentials = stsCredential
47}
注意: 目前使用STS配置BCI Client时,无论对应BCI服务的Endpoint在哪里,STS的Endpoint都需配置为http://sts.bj.baidubce.com。 上述代码中创建STS对象时使用此默认值。
配置 HTTPS 协议访问 BCI
BCI 支持 HTTPS 传输协议,您可以通过在创建 BCI Client 对象时指定的 Endpoint 中指明 HTTPS 的方式,在 BCI Go SDK 中使用 HTTPS 访问 BCI 服务:
1package main
2
3import (
4 "log"
5
6 "github.com/baidubce/bce-sdk-go/services/bci"
7)
8
9func main() {
10 ENDPOINT := "https://bci.bj.baidubce.com" // 指明使用 HTTPS 协议
11 AK, SK := "your-access-key-id", "your-secret-access-key"
12
13 bciClient, err := bci.NewClient(AK, SK, ENDPOINT)
14 if err != nil {
15 log.Fatal(err)
16 }
17
18 _ = bciClient
19}
当 Endpoint 以 https:// 开头时,后续请求会通过 HTTPS 发送,AK/SK 的配置方式与普通初始化保持一致。
配置BCI Client
如果用户需要配置BCI Client的一些细节的参数,可以在创建BCI Client对象之后,使用该对象的导出字段Config进行自定义配置,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问 BCI 服务:
1package main
2
3import (
4 "log"
5
6 "github.com/baidubce/bce-sdk-go/services/bci"
7)
8
9func main() {
10 // 创建 BCI Client 对象
11 AK, SK := "your-access-key-id", "your-secret-access-key"
12 ENDPOINT := "bci.bj.baidubce.com"
13 client, err := bci.NewClient(AK, SK, ENDPOINT)
14 if err != nil {
15 log.Fatal(err)
16 }
17
18 // 代理使用本地的 8080 端口
19 client.Config.ProxyUrl = "127.0.0.1:8080"
20}
ProxyUrl 用于配置客户端出站请求的代理地址。通过代理访问时,不会改变 Endpoint 对应的服务区域,服务端仍会按照实际请求中的鉴权信息处理请求。
设置网络参数
用户可以通过如下的示例代码进行网络参数的设置:
1package main
2
3import (
4 "log"
5
6 "github.com/baidubce/bce-sdk-go/bce"
7 "github.com/baidubce/bce-sdk-go/services/bci"
8)
9
10func main() {
11 AK, SK := "your-access-key-id", "your-secret-access-key"
12 ENDPOINT := "bci.bj.baidubce.com"
13 client, err := bci.NewClient(AK, SK, ENDPOINT)
14 if err != nil {
15 log.Fatal(err)
16 }
17
18 // 配置不进行重试,默认为 Back Off 重试
19 client.Config.Retry = bce.NewNoRetryPolicy()
20
21 // 配置连接超时时间为 30 秒
22 client.Config.ConnectionTimeoutInMillis = 30 * 1000
23}
Retry 用于控制客户端的重试策略,ConnectionTimeoutInMillis 用于配置连接超时时间,单位为毫秒。将其设置为 30 * 1000 时,表示连接超时时间为 30 秒。
配置生成签名字符串选项
1package main
2
3import (
4 "log"
5
6 "github.com/baidubce/bce-sdk-go/services/bci"
7)
8
9func main() {
10 AK, SK := "your-access-key-id", "your-secret-access-key"
11 ENDPOINT := "bci.bj.baidubce.com"
12 client, err := bci.NewClient(AK, SK, ENDPOINT)
13 if err != nil {
14 log.Fatal(err)
15 }
16
17 // 配置签名使用的 HTTP 请求头为 Host
18 headersToSign := map[string]struct{}{"Host": {}}
19 client.Config.SignOption.HeadersToSign = headersToSign
20
21 // 配置签名的有效期为 30 秒
22 client.Config.SignOption.ExpireSeconds = 30
23}
HeadersToSign 用于指定生成签名字符串时参与计算的 HTTP 头,ExpireSeconds 用于指定签名的有效期。仅对 Host 参与签名,并将签名有效期设置为 30 秒时,也可用于发起 BCI 请求。
参数说明
用户使用 Go SDK 访问 BCI 时,创建的 BCI 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 鉴权时使用,详见“使用 STS 创建 BCI Client”小节。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的指数级增长方式进行重试,直到达到最大重试次数或者最长重试时间为止。
评价此篇文章
