NAT
更新时间：2020-07-23
初始化
确认Endpoint
在确认您使用SDK时配置的Endpoint时，可先阅读开发人员指南中关于NAT服务域名的部分，理解Endpoint相关的概念。百度云目前开放了多区域支持，请参考区域选择说明。
目前支持“华北-北京”、“华南-广州”、“华东-苏州”、“香港”、“金融华中-武汉”和“华北-保定”六个区域。对应信息为：
| 访问区域 | 对应Endpoint | 协议 |
|---|---|---|
| BJ | bcc.bj.baidubce.com | HTTP and HTTPS |
| GZ | bcc.gz.baidubce.com | HTTP and HTTPS |
| SU | bcc.su.baidubce.com | HTTP and HTTPS |
| HKG | bcc.hkg.baidubce.com | HTTP and HTTPS |
| FWH | bcc.fwh.baidubce.com | HTTP and HTTPS |
| BD | bcc.bd.baidubce.com | HTTP and HTTPS |
获取密钥
要使用百度云NAT，您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问NAT做签名验证。
可以通过如下步骤获得并了解您的AK/SK信息：
新建NAT Client
NAT Client是NAT服务的客户端，为开发者与NAT服务进行交互提供了一系列的方法。
使用AK/SK新建NAT Client
通过AK/SK方式访问NAT，用户可以参考如下代码新建一个NAT Client：
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>
// 用户指定的Endpoint
ENDPOINT := <domain-name>
// 初始化一个NATClient
natClient, err := vpc.NewClient(AK, SK, ENDPOINT)
}在上面代码中，ACCESS_KEY_ID对应控制台中的“Access Key ID”，SECRET_ACCESS_KEY对应控制台中的“Access Key Secret”，获取方式请参考《操作指南 如何获取AKSK》。第三个参数ENDPOINT支持用户自己指定域名，如果设置为空字符串，会使用默认域名作为VPC的服务地址。
注意：
ENDPOINT参数需要用指定区域的域名来进行定义，如服务所在区域为北京，则为bcc.bj.baidubce.com。
使用STS创建NAT Client
申请STS token
NAT可以通过STS机制实现第三方的临时授权访问。STS（Security Token Service）是百度云提供的临时授权服务。通过STS，您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。
通过STS方式访问NAT，用户需要先通过STS的client申请一个认证字符串。
用STS token新建NAT Client
申请好STS后，可将STS Token配置到NAT Client中，从而实现通过STS Token创建NAT Client。
代码示例
GO SDK实现了STS服务的接口，用户可以参考如下完整代码，实现申请STS Token和创建NAT Client对象：
import (
"fmt"
"github.com/baidubce/bce-sdk-go/auth" //导入认证模块
"github.com/baidubce/bce-sdk-go/services/vpc" //导入VPC服务模块
"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创建NAT服务的Client对象，Endpoint使用默认值
natClient, err := vpc.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "bcc.bj.baidubce.com")
if err != nil {
fmt.Println("create nat 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
}
natClient.Config.Credentials = stsCredential
}注意： 目前使用STS配置NAT Client时，无论对应NAT服务的Endpoint在哪里，STS的Endpoint都需配置为http://sts.bj.baidubce.com。上述代码中创建STS对象时使用此默认值。
配置HTTPS协议访问NAT
NAT支持HTTPS传输协议，您可以通过在创建NAT Client对象时指定的Endpoint中指明HTTPS的方式，在NAT GO SDK中使用HTTPS访问NAT服务：
// import "github.com/baidubce/bce-sdk-go/services/vpc"
ENDPOINT := "https://bcc.bj.baidubce.com" //指明使用HTTPS协议
AK, SK := <your-access-key-id>, <your-secret-access-key>
natClient, _ := vpc.NewClient(AK, SK, ENDPOINT)配置NAT Client
如果用户需要配置NAT Client的一些细节的参数，可以在创建NAT Client对象之后，使用该对象的导出字段Config进行自定义配置，可以为客户端配置代理，最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问NAT服务：
// import "github.com/baidubce/bce-sdk-go/services/vpc"
//创建NAT Client对象
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bcc.bj.baidubce.com"
client, _ := vpc.NewClient(AK, SK, ENDPOINT)
//代理使用本地的8080端口
client.Config.ProxyUrl = "127.0.0.1:8080"设置网络参数
用户可以通过如下的示例代码进行网络参数的设置：
// import "github.com/baidubce/bce-sdk-go/services/vpc"
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bcc.bj.baidubce.com"
client, _ := bcc.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/vpc"
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bcc.bj.baidubce.com"
client, _ := bcc.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访问NAT时，创建的NAT 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创建NAT 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的指数级增长的方式进行重试，直到达到最大重试测试或者最长重试时间为止。
NAT网关管理
NAT（Network Address Translation）网关为私有网络提供访问Internet服务，支持SNAT和DNAT，可以使多台云服务器共享公网IP资源访问Internet，也可以使云服务器能够提供Internet服务。NAT网关可以绑定EIP实例及共享带宽，为云服务器实现从内网IP到公网IP的多对一或多对多的地址转换服务。
创建NAT网关
使用以下代码可以创建nat网关。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
args := &vpc.CreateNatGatewayArgs{
// 设置nat网关的名称
Name: name,
// 设置nat网关所属的vpc id
VpcId: vpcId,
// 设置nat网关的规格
Spec: vpc.NAT_GATEWAY_SPEC_SMALL,
// 设置nat网关的eip列表
Eips: []string{eip},
// 设置nat网关的计费信息
Billing: &vpc.Billing{
PaymentTiming: vpc.PAYMENT_TIMING_POSTPAID,
},
}
result, err := client.CreateNatGateway(args)
if err != nil {
fmt.Println("create nat gateway error: ", err)
return
}
fmt.Println("create nat gateway success, nat gateway id: ", result.NatId)注意: 创建过程中，应注意以下事项:
- NAT网关的名称，由大小写字母、数字以及-_ /.特殊字符组成，必须以字母开头，长度1-65
- NAT网关的大小，有small(最多支持绑定5个公网IP)、medium(最多支持绑定10个公网IP)、large(最多支持绑定15个公网IP)三种
- NAT网关可以关联一个公网EIP或者共享带宽中的一个或多个EIP
- 付款方式支持预支付（Prepaid）和后支付（Postpaid）两种，预支付当前仅支持按月，时长取值范围: [1,2,3,4,5,6,7,8,9,12,24,36]
查询NAT网关列表
使用以下代码可以查询符合条件的nat网关列表。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
args := &vpc.ListNatGatewayArgs{
// 设置nat网关所属的vpc id，必选
VpcId: vpcId,
// 指定查询的NAT的Id
NatId: natId,
// 指定查询的NAT的名称
Name: name,
// 指定查询的NAT绑定的EIP
Ip: ip,
// 设置nat网关批量获取列表的查询的起始位置
Marker: marker,
// 设置nat网关每页包含的最大数量，最大数量不超过1000。缺省值为1000
MaxKeys: maxKeys,
}
result, err := client.ListNatGateway(args)
if err != nil {
fmt.Println("list nat gateway error: ", err)
return
}
// 返回标记查询的起始位置
fmt.Println("nat list marker: ", result.Marker)
// true表示后面还有数据，false表示已经是最后一页
fmt.Println("nat list isTruncated: ", result.IsTruncated)
// 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
fmt.Println("nat list nextMarker: ", result.NextMarker)
// 每页包含的最大数量
fmt.Println("nat list maxKeys: ", result.MaxKeys)
// 获取nat的列表信息
for _, nat := range result.Nats {
fmt.Println("nat id: ", nat.Id)
fmt.Println("nat name: ", nat.Name)
fmt.Println("nat vpcId: ", nat.VpcId)
fmt.Println("nat spec: ", nat.Spec)
fmt.Println("nat eips: ", nat.Eips)
fmt.Println("nat status: ", nat.Status)
fmt.Println("nat paymentTiming: ", nat.PaymentTiming)
fmt.Println("nat expireTime: ", nat.ExpiredTime)
}注意:
- 可根据NAT网关ID、NAT网关的name、NAT网关绑定的EIP来查询。
- 若不提供查询条件，则默认查询覆盖所有NAT网关
- vpcId为必选参数
查询NAT网关详情
使用以下代码可以查询特定nat网关的详细信息。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
result, err := client.GetNatGatewayDetail(natId)
if err != nil {
fmt.Println("get nat gateway details error: ", err)
return
}
// 查询得到nat网关的id
fmt.Println("nat id: ", result.Id)
// 查询得到nat网关的名称
fmt.Println("nat name: ", result.Name)
// 查询得到nat网关所属的vpc id
fmt.Println("nat vpcId: ", result.VpcId)
// 查询得到nat网关的大小
fmt.Println("nat spec: ", result.Spec)
// 查询得到nat网关绑定的EIP的IP地址列表
fmt.Println("nat eips: ", result.Eips)
// 查询得到nat网关的状态
fmt.Println("nat status: ", result.Status)
// 查询得到nat网关的付费方式
fmt.Println("nat paymentTiming: ", result.PaymentTiming)
// 查询得到nat网关的过期时间
fmt.Println("nat expireTime: ", result.ExpiredTime)更新NAT网关名称
使用以下代码可以对nat网关的名称进行更改。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
args := &vpc.UpdateNatGatewayArgs{
// 设置nat网关的最新名称
Name: "TestNatUpdate",
}
if err := client.UpdateNatGateway(natId, args); err != nil {
fmt.Println("update nat gateway error: ", err)
return
}
fmt.Printf("update nat gateway %s success.", natId)注意: 目前该接口仅支持对网关名称属性的更改。
绑定EIP
使用以下代码可以为nat网关绑定eip。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
args := &vpc.BindEipsArgs{
// 设置绑定的EIP ID列表
Eips: []string{eip},
}
if err := client.BindEips(natId, args); err != nil {
fmt.Println("bind eips error: ", err)
return
}
fmt.Println("bind eips success.")注意:
- 若该NAT已经绑定EIP，必须解绑后才可绑定。
- 若该NAT已经绑定共享带宽，可以继续绑定该共享带宽中的其他IP。
解绑EIP
使用以下代码可以为nat网关解绑eip。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
args := &vpc.UnBindEipsArgs{
// 设置解绑的EIP ID列表
Eips: []string{eip},
}
if err := client.UnBindEips(natId, args); err != nil {
fmt.Println("unbind eips error: ", err)
return
}
fmt.Println("unbind eips success.")释放NAT网关
使用以下代码释放特定的nat网关。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
if err := client.DeleteNatGateway(natId, clientToken); err != nil {
fmt.Println("delete nat gateway error: ", err)
return
}
fmt.Printf("delete nat gateway %s success.", natId)注意: 预付费未到期的NAT网关不能释放。
NAT网关续费
使用以下接口完成nat网关的续费操作，延长过期时间。
//import "github.com/baidubce/bce-sdk-go/services/vpc"
args := &vpc.RenewNatGatewayArgs{
// 设置nat网关续费的订单信息
Billing: &vpc.Billing{
Reservation: &vpc.Reservation{
ReservationLength: 1,
ReservationTimeUnit: "month",
},
},
}
if err := client.RenewNatGateway(natId, args); err != nil {
fmt.Println("renew nat gateway error: ", err)
return
}
fmt.Printf("renew nat gateway %s success.", natId)注意:
- 后付费的NAT网关不能续费