对等连接

更新时间：2024-01-08

确认Endpoint

在确认您使用SDK时配置的Endpoint时，可先阅读开发人员指南中关于PeerConn服务域名的部分，理解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

获取密钥

要使用百度云PeerConn，您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问PeerConn做签名验证。

可以通过如下步骤获得并了解您的AK/SK信息：

注册百度云账号

创建AK/SK

新建PeerConn Client

PeerConn Client是PeerConn服务的客户端，为开发者与PeerConn服务进行交互提供了一系列的方法。

使用AK/SK新建PeerConn Client

通过AK/SK方式访问PeerConn，用户可以参考如下代码新建一个PeerConn 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>

	// 初始化一个PeerConnClient
	peerConnClient, 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创建PeerConn Client

申请STS token

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

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

用STS token新建PeerConn Client

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

代码示例

GO SDK实现了STS服务的接口，用户可以参考如下完整代码，实现申请STS Token和创建PeerConn 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创建PeerConn服务的Client对象，Endpoint使用默认值
	peerConnClient, err := peerConn.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "bcc.bj.baidubce.com")
	if err != nil {
		fmt.Println("create PeerConn 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
	}
	peerConnClient.Config.Credentials = stsCredential
}

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

配置HTTPS协议访问PeerConn

PeerConn支持HTTPS传输协议，您可以通过在创建PeerConn Client对象时指定的Endpoint中指明HTTPS的方式，在PeerConn GO SDK中使用HTTPS访问PeerConn服务：

// 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>
peerConnClient, _ := vpc.NewClient(AK, SK, ENDPOINT)

配置PeerConn Client

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

使用代理

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

// import "github.com/baidubce/bce-sdk-go/services/vpc"

//创建PeerConn Client对象
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bcc.bj.baidubce.com"
client, _ := peerConn.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访问PeerConn时，创建的PeerConn 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创建PeerConn 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的指数级增长的方式进行重试，直到达到最大重试测试或者最长重试时间为止。

对等连接管理

对等连接（Peer Connection）为用户提供了VPC级别的网络互联服务，使用户实现在不同虚拟网络之间的流量互通，实现同区域/跨区域，同用户/不同用户之间稳定高速的虚拟网络互联。

创建对等连接

使用以下代码创建对等连接。

函数声明

type CreatePeerConnArgs struct {
	ClientToken     string           `json:"-"`
	BandwidthInMbps int              `json:"bandwidthInMbps"`
	Description     string           `json:"description,omitempty"`
	LocalIfName     string           `json:"localIfName,omitempty"`
	LocalVpcId      string           `json:"localVpcId"`
	PeerAccountId   string           `json:"peerAccountId,omitempty"`
	PeerVpcId       string           `json:"peerVpcId"`
	PeerRegion      string           `json:"peerRegion"`
	PeerIfName      string           `json:"peerIfName,omitempty"`
	Billing         *Billing         `json:"billing"`
	Tags            []model.TagModel `json:"tags,omitempty"`
}

type CreatePeerConnResult struct {
	PeerConnId string `json:"peerConnId"`
}

func (c *Client) CreatePeerConn(args *CreatePeerConnArgs) (*CreatePeerConnResult, error)

参数含义 请参考OpenAPI文档： https://cloud.baidu.com/doc/VPC/s/bjwvyue8y

返回值

操作成功：

{
    "peerConnId": "peerconn-9td54fmx143e"
}

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例 具体代码示例参考：example_create_peer_conn.go

注意:

对于本端区域和对端区域相同的对等连接，只支持后付费。

跨账号的对等连接，必须接受端接受后对等连接才可用。

对于同账号的对等连接，系统会触发对端自动接受。

任意两个VPC之间最多只能存在一条对等连接。

发起端和接收端的VPC不能是同一个。

如果本端vpc和对端vpc均为中继vpc,则不可以建立对等连接。

查询对等连接列表

使用以下代码可以查询对等连接的列表信息。

函数声明

type ListPeerConnsArgs struct {
	VpcId   string
	Marker  string
	MaxKeys int
}

type ListPeerConnsResult struct {
	PeerConns   []PeerConn `json:"peerConns"`
	Marker      string     `json:"marker"`
	IsTruncated bool       `json:"isTruncated"`
	NextMarker  string     `json:"nextMarker"`
	MaxKeys     int        `json:"maxKeys"`
}

func (c *Client) ListPeerConn(args *ListPeerConnsArgs) (*ListPeerConnsResult, error)

使用该接口可以查询得到所有符合条件的对等连接信息，其中，vpcId是可选参数。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/Fjwvyuemr

返回值

操作成功：

{
	 "peerConns":[
        {
            "peerConnId":"peerconn-9td54fmx143e",
            "role":"initiator",
            "status":"active",
            "bandwithInMbp":500,
            "description":"peer_diff_account",
            "localIfId":"qpif-ken2yc9j8x56",
            "localIfName":"int-SpLVk25R",
            "localVpcId":"vpc-13vuxu016dew",
            "localRegion":"bj",
            "peerVpcId":"vpc-jcvmhw9h1a35",
            "peerRegion":"bj",
            "peerAccountId":"75c14a239bb24b9e88b695e8e9e47952",
			"dnsStatus":"close",
            "paymentTiming":"Postpaid",
			"createdTime" :"2018-08-07 19:46:55",
            "expiredTime":expiredTime
        }
    ]
    "marker":"peerconn-9td54fmx143e",
    "isTruncated": true,
    "nextMarker": "peerconn-srbvvxmjn7ux",
    "maxKeys": 1
}

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_list_peer_conn.go

查看对等连接详情

通过以下代码可以查询特定对等连接的详细信息。

函数声明

type PeerConn struct {
	PeerConnId      string             `json:"peerConnId"`
	Role            PeerConnRoleType   `json:"role"`
	Status          PeerConnStatusType `json:"status"`
	BandwidthInMbps int                `json:"bandwidthInMbps"`
	Description     string             `json:"description"`
	LocalIfId       string             `json:"localIfId"`
	LocalIfName     string             `json:"localIfName"`
	LocalVpcId      string             `json:"localVpcId"`
	LocalRegion     string             `json:"localRegion"`
	PeerVpcId       string             `json:"peerVpcId"`
	PeerRegion      string             `json:"peerRegion"`
	PeerAccountId   string             `json:"peerAccountId"`
	PaymentTiming   string             `json:"paymentTiming"`
	DnsStatus       DnsStatusType      `json:"dnsStatus"`
	CreatedTime     string             `json:"createdTime"`
	ExpiredTime     string             `json:"expiredTime"`
	Tags            []model.TagModel   `json:"tags"`
}

func (c *Client) GetPeerConnDetail(peerConnId string, role PeerConnRoleType) (*PeerConn, error)

注意: "initiator"表示发起端"acceptor"表示接受端，同region的对等连接可以据此进行详情查询，若不设置该参数，同region则随机返回一端信息。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/Sjwvyudwm

返回值

操作成功：

{
    "peerConnId":"peerconn-cbp4xrtzk3fb",
    "role":"initiator",
    "status":"active",
    "bandwithInMbp":1000,
    "description":"mypeerconn",
    "localIfId":"qpif-qz9a61ujsizt",
    "localIfName":"dsds",
    "localVpcId":"20fada00-f66e-40de-bed4-954af13dc0b2",
    "localRegion":"bj",
    "peerVpcId":"1aa1427d-92cf-45d0-bc31-ab4d9fe71425",
    "peerRegion":"bj",
    "peerAccountId":"75c14a239bb24b9e88b695e8e9e47952",
    "createdTime": "2018-08-03 20:38:43"
    "expiredTime":null,
    "dnsStatus":"close",
    "paymentTiming":"Postpaid",
    "tags":[
        {
          "tagKey": "tagKey",
          "tagValue": "tagValue"
        }
    ]
}

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_get_peer_conn_detail.go

更新对等连接本端接口名称和备注

使用以下代码可以更新对等连接本端接口名称和备注。

函数声明

type UpdatePeerConnArgs struct {
	LocalIfId   string `json:"localIfId"`
	Description string `json:"description,omitempty"`
	LocalIfName string `json:"localIfName,omitempty"`
}

func (c *Client) UpdatePeerConn(peerConnId string, args *UpdatePeerConnArgs) error

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/1jwvyufpd

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_update_peer_conn.go

处理对等连接申请

使用以下代码可以接受对等连接的申请信息。

函数声明

func (c *Client) AcceptPeerConnApply(peerConnId, clientToken string) error

注意:

发起端发出的连接请求超时时间为7天，超时后发起端对等连接的状态为协商失败。

接收端拒绝后，发起端对等连接状态为协商失败。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/wjwvyud6p

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_accept_peer_conn_apply.go

释放对等连接

使用以下代码可以释放特定的对等连接。

函数声明

func (c *Client) DeletePeerConn(peerConnId, clientToken string) error

注意:

跨账号只有发起端可以释放。

预付费可用且未到期的对等连接不能释放。

预付费协商失败的可以释放。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/0jwvyucfy

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_delete_peer_conn.go

对等连接带宽升降级

使用以下代码可以为指定的对等连接进行带宽升级操作。

函数声明

type ResizePeerConnArgs struct {
	NewBandwidthInMbps int    `json:"newBandwidthInMbps"`
	ClientToken        string `json:"-"`
}

func (c *Client) ResizePeerConn(peerConnId string, args *ResizePeerConnArgs) error

注意:

跨账号只有发起端才可以进行带宽的升降级操作。

预付费的对等连接只能进行带宽升级不能降级。

后付费的对等连接可以进行带宽的升级和降级。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/Wjwvyufcb

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_resize_peer_conn.go

对等连接续费

使用以下代码可以为对等连接进行续费操作，延长过期时间。

函数声明

type RenewPeerConnArgs struct {
	Billing     *Billing `json:"billing"`
	ClientToken string   `json:"-"`
}

func (c *Client) RenewPeerConn(peerConnId string, args *RenewPeerConnArgs) error

注意:

后付费的对等连接不能续费。

跨账号续费操作只能由发起端来操作。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/9jwvyudie

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_renew_peer_conn.go

开启对等连接同步DNS

使用以下代码可以开启对等连接同步DNS记录。

函数声明

type PeerConnSyncDNSArgs struct {
	Role        PeerConnRoleType `json:"role"`
	ClientToken string           `json:"-"`
}

func (c *Client) OpenPeerConnSyncDNS(peerConnId string, args *PeerConnSyncDNSArgs) error

注意:

对等连接的状态为可用的时候才能开启DNS。

对等连接的DNS状态为同步中或同步关闭中不可开启同步DNS。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/Qjwvyuf0h

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_open_peer_conn_sync_dns.go

关闭对等连接同步DNS

使用以下代码可以关闭对等连接同步DNS记录。

函数声明

type PeerConnSyncDNSArgs struct {
	Role        PeerConnRoleType `json:"role"`
	ClientToken string           `json:"-"`
}

func (c *Client) ClosePeerConnSyncDNS(peerConnId string, args *PeerConnSyncDNSArgs) error

注意:

对等连接的状态为可用的时候才能关闭DNS。

对等连接的DNS状态为同步中或同步关闭中不可关闭同步DNS。

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/ojwvyucs2

返回值

操作成功：

无特殊返回参数

操作失败：

抛出异常，异常列表参考：对等连接异常列表

代码示例

具体代码示例参考：example_close_peer_conn_sync_dns.go

VPN

专线网关

百度智能云

私有网络 VPC

私有网络 VPC

对等连接

确认Endpoint

获取密钥

新建PeerConn Client

使用AK/SK新建PeerConn Client

使用STS创建PeerConn Client

配置HTTPS协议访问PeerConn

配置PeerConn Client

使用代理

设置网络参数

配置生成签名字符串选项

对等连接管理

创建对等连接

查询对等连接列表

查看对等连接详情

更新对等连接本端接口名称和备注

处理对等连接申请

释放对等连接

对等连接带宽升降级

对等连接续费

开启对等连接同步DNS

关闭对等连接同步DNS