初始化
所有文档

          弹性公网IP EIP

          初始化

          确认Endpoint

          在确认您使用SDK时配置的Endpoint时,可先参考阅读API参考中关于 API服务域名 的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明。 对应信息为:

          访问区域 对应Endpoint
          北京 eip.bj.baidubce.com
          广州 eip.gz.baidubce.com
          苏州 eip.su.baidubce.com
          香港 eip.hkg.baidubce.com
          武汉 eip.fwh.baidubce.com
          保定 eip.bd.baidubce.com

          获取密钥

          要使用百度智能云EIP,您需要拥有一个有效的 AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问EIP做签名验证。 可以通过如下步骤获得并了解您的AK/SK信息: 注册百度智能云账号 创建AK/SK

          创建Client

          每种具体的服务都有一个Client对象,为开发者与对应的服务进行交互封装了一系列易用的方法。开发者可参考SDK中具体服务对应的目录下的说明文档使用相应的服务。

          使用AK/SK新建EIP Client

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

          import (
              "github.com/baidubce/bce-sdk-go/services/eip"
          )
          
          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>
          
              // 初始化一个eipClient
              eipClient, err := eip.NewClient(AK, SK, ENDPOINT)
          }

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

          使用STS创建EIP Client

          申请STS token

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

          通过STS方式访问EIP,用户需要先通过STS的client申请一个认证字符串。

          用STS token新建eip Client

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

          代码示例

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

          import (
              "fmt"
          
              "github.com/baidubce/bce-sdk-go/auth"         //导入认证模块
              "github.com/baidubce/bce-sdk-go/services/eip" //导入EIP服务模块
              "github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
          )
          
          func main() {
              // 创建STS服务的Client对象,Endpoint使用默认值
              AK, SK := <your-access-key-id>, <your-secret-access-key>
              stsClient, err := sts.NewClient(AK, SK)
              if err != nil {
                  fmt.Println("create sts client object :", err)
                  return
              }
          
              // 获取临时认证token,有效期为60秒,ACL为空
              stsObj, err := stsClient.GetSessionToken(60, "")
              if err != nil {
                  fmt.Println("get session token failed:", err)
                  return
              }
              fmt.Println("GetSessionToken result:")
              fmt.Println("  accessKeyId:", stsObj.AccessKeyId)
              fmt.Println("  secretAccessKey:", stsObj.SecretAccessKey)
              fmt.Println("  sessionToken:", stsObj.SessionToken)
              fmt.Println("  createTime:", stsObj.CreateTime)
              fmt.Println("  expiration:", stsObj.Expiration)
              fmt.Println("  userId:", stsObj.UserId)
          
              // 使用申请的临时STS创建EIP服务的Client对象,Endpoint使用默认值
              eipClient, err := eip.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "eip.bj.baidubce.com")
              if err != nil {
                  fmt.Println("create eip client failed:", err)
                  return
              }
              stsCredential, err := auth.NewSessionBceCredentials(
                  stsObj.AccessKeyId,
                  stsObj.SecretAccessKey,
                  stsObj.SessionToken)
              if err != nil {
                  fmt.Println("create sts credential object failed:", err)
                  return
              }
              eipClient.Config.Credentials = stsCredential
          }

          注意: 目前使用STS配置rip Client时,无论对应EIP服务的Endpoint在哪里,STS的Endpoint都需配置为http://sts.bj.baidubce.com。 上述代码中创建STS对象时使用此默认值。

          调用功能接口

          开发者基于创建的对应服务的Client对象,即可调用相应的功能接口,使用百度云产品的功能。

          示例

          下面以百度云弹性公网IP(EIP)为例,给出一个基本的使用示例,详细使用说明请参考各服务的详细说明文档。

          import (
              "github.com/baidubce/bce-sdk-go/services/eip"
          )
          
          func main() {
              // 用户的Access Key ID和Secret Access Key
              ACCESS_KEY_ID, SECRET_ACCESS_KEY := "<your-access-key-id>", "<your-secret-access-key>"
          
              // EIP服务的Endpoint
              ENDPOINT := "<domain-name>"
          
              // 创建EIP服务的Client
          	EIP_CLIENT, _ = NewClient(AK, SK, Endpoint)
          
              // 创建EIP
          	args := &CreateEipArgs{
          		Name:            "sdk-eip",
          		BandWidthInMbps: 1,
          		Billing: &Billing{
          			PaymentTiming: "Postpaid",
          			BillingMethod: "ByTraffic",
          		},
          		ClientToken: getClientToken(),
          	}
          	result, err := EIP_CLIENT.CreateEip(args)
              if err != nil {
                  fmt.Println("create eip failed:", err)
              }
              fmt.Println("create eip success ,eip address is:", result.Eip)
          }

          配置

          使用HTTPS协议

          该SDK支持使用HTTPS协议访问百度云的服务产品。要使用HTTPS协议,只需在您创建对应服务的Client对象时指定的Endpoint中指明使用https协议的域名即可,SDK会自动识别并使用HTTPS协议访问。

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

          配置EIP Client

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

          使用代理

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

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

          设置网络参数

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

          // import "github.com/baidubce/bce-sdk-go/services/eip"
          
          AK, SK := <your-access-key-id>, <your-secret-access-key>
          ENDPOINT := "eip.bj.baidubce.com"
          client, _ := eip.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/eip"
          
          AK, SK := <your-access-key-id>, <your-secret-access-key>
          ENDPOINT := "eip.bj.baidubce.com"
          client, _ := eip.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时,创建的对应服务的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分钟

          说明:

          1. Credentials字段使用auth.NewBceCredentials与auth.NewSessionBceCredentials函数创建,默认使用前者,后者为使用STS鉴权时使用。
          2. SignOption字段为生成签名字符串时的选项,详见下表说明:
          名称 类型 含义
          HeadersToSign map[string]struct{} 生成签名字符串时使用的HTTP头
          Timestamp int64 生成的签名字符串中使用的时间戳,默认使用请求发送时的值
          ExpireSeconds int 签名字符串的有效期
           其中,HeadersToSign默认为`Host`,`Content-Type`,`Content-Length`,`Content-MD5`;TimeStamp一般为零值,表示使用调用生成认证字符串时的时间戳,用户一般不应该明确指定该字段的值;ExpireSeconds默认为1800秒即30分钟。
          1. 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
          上一篇
          安装SDK工具包
          下一篇
          EIP