初始化
更新时间:2024-01-08
使用步骤
确认Endpoint
在使用SDK之前,需确认您将接入的百度云产品的Endpoint(服务域名)。以百度私有网络产品为例,可阅读服务域名的部分,理解Endpoint相关的概念。其他服务类似,需理解并确认对应服务的Endpoint。
创建Client对象
每种具体的服务都有一个Client
对象,为开发者与对应的服务进行交互封装了一系列易用的方法。开发者可参考SDK中具体服务对应的目录下的说明文档使用相应的服务。
调用功能接口
开发者基于创建的对应服务的Client
对象,即可调用相应的功能接口,使用百度云产品的功能。
示例
下面以百度云私有网络服务(VPC)为例,给出一个基本的使用示例,详细使用说明请参考各服务的详细说明文档。
import (
"github.com/baidubce/bce-sdk-go/services/vpc"
)
func main() {
// 用户的Access Key ID和Secret Access Key
ACCESS_KEY_ID, SECRET_ACCESS_KEY := "<your-access-key-id>", "<your-secret-access-key>"
// VPC服务的Endpoint
ENDPOINT := "<domain-name>"
// 创建VPC服务的Client
vpcClient, err := vpc.NewClient(AK, SK, ENDPOINT)
// 创建VPC
args := &CreateVPCArgs{
Name: "TestSDK-VPC",
Description: "vpc test",
Cidr: "192.168.0.0/16",
ClientToken: "clientToken",
}
result, err := vpcClient.CreateVPC("<your-create-vpc-args>"); err != nil {
if err != nil {
fmt.Println("create vpc failed:", err)
}
fmt.Println("create vpc success ,vpc id ", result.VPCID)
}
配置
使用HTTPS协议
该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分钟 |
说明:
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的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。
开发者可据此进行详细参数的配置,下面给出部分配置示例:
// 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