初始化
确认Endpoint
在使用SDK之前,需确认您将接入的百度云产品的Endpoint(服务域名)。可阅读CCR访问域名,理解Endpoint相关的概念。百度云目前开放了多区域支持,请参考区域选择说明。
获取密钥
要使用百度智能云CCR企业版,您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问CCR企业版做签名验证。
可以通过如下步骤获得并了解您的AK/SK信息:
新建CCR Client
CCE Client是CCR企业版服务的客户端,为开发者与CCR企业版服务进行交互提供了一系列的方法。
使用AK/SK新建CCR Client
通过AK/SK方式访问CCR企业版,用户可以参考如下代码新建一个CCR Client:
import (
ccrapi "github.com/baidubce/bce-sdk-go/services/eccr"
)
func main() {
// 用户的Access Key ID和Secret Access Key
AK, SK := <your-access-key-id>, <your-secret-access-key>
// 用户指定的Endpoint
ENDPOINT := <domain-name>
// 初始化一个CCRClient
ccrClient, err := ccrapi.NewClient(AK, SK, ENDPOINT)
}
在上面代码中,AK
对应控制台中的“Access Key ID”,SK
对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 管理ACCESSKEY》。第三个参数ENDPOINT
支持用户自己指定域名,如果设置为空字符串,会使用默认域名作为CCR的服务地址。
注意:
ENDPOINT
参数需要用指定区域的域名来进行定义,如服务所在区域为北京,则为bcc.bj.baidubce.com
。
配置HTTPS协议访问CCR企业版
该SDK支持使用HTTPS协议访问百度云的服务产品。要使用HTTPS协议,只需在您创建对应服务的Client对象时指定的Endpoint中指明使用HTTPS协议的域名即可,SDK会自动识别并使用HTTPS协议访问。
详细配置
开发者使用GO SDK时,创建的对应服务的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分钟 |
开发者可据此进行详细参数的配置,下面给出部分配置示例:
// client为某一种具体服务的`Client`对象
// 配置请求代理地址
client.Config.ProxyUrl = "127.0.0.1:8080"
// 配置不进行重试,默认为Back Off重试
client.Config.Retry = bce.NewNoRetryPolicy()
// 配置连接超时时间为30秒
client.Config.ConnectionTimeoutInMillis = 30 * 1000
// 配置签名使用的HTTP请求头为`Host`
client.Config.SignOption.HeadersToSign = map[string]struct{}{"Host": struct{}{}}
// 配置签名的有效期为30秒
client.Config.SignOption.ExpireSeconds = 30
说明:
- 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的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。