专线
专线服务
概述
本文档主要介绍ET GO SDK的使用。在使用本文档前,您需要先了解专线的一些基本知识,并已开通了专线服务。若您还不了解专线,可以参考产品描述和操作指南。
初始化
获取Endpoint
在确认您使用SDK配置Endpoint时,可先阅读开发人员指南中关于 ET服务域名的部分,理解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 |
获取密钥
要使用百度云ET,您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问ET做签名验证。
可以通过如下步骤获得并了解您的AK/SK信息:
新建ET Client
ET Client是ET服务的客户端,为开发者与ET服务进行交互提供了一系列的方法。
使用AK/SK新建ET Client
通过AK/SK方式访问ET,用户可以参考如下代码新建一个ET Client:
1import (
2 "github.com/baidubce/bce-sdk-go/services/et"
3)
4
5func main() {
6 // 用户的Access Key ID和Secret Access Key
7 ACCESS_KEY_ID, SECRET_ACCESS_KEY := <your-access-key-id>, <your-secret-access-key>
8
9 // 用户指定的Endpoint
10 ENDPOINT := <domain-name>
11
12 // 初始化一个ET Client
13 etClient, err := et.NewClient(AK, SK, ENDPOINT)
14}
在上面代码中,ACCESS_KEY_ID
对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY
对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 如何获取AKSK》。第三个参数ENDPOINT
支持用户自己指定域名,如果设置为空字符串,会使用默认域名作为ET的服务地址。
注意:
ENDPOINT
参数需要用指定区域的域名来进行定义,如服务所在区域为北京,则为bcc.bj.baidubce.com
。
使用STS创建ET Client
申请STS token
ET可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。
通过STS方式访问ET,用户需要先通过STS的client申请一个认证字符串。
用STS token新建ET Client
申请好STS后,可将STS Token配置到ET Client中,从而实现通过STS Token创建ET Client。
代码示例
GO SDK实现了STS服务的接口,用户可以参考如下完整代码,实现申请STS Token和创建ET Client对象:
1import (
2 "fmt"
3
4 "github.com/baidubce/bce-sdk-go/auth" //导入认证模块
5 "github.com/baidubce/bce-sdk-go/services/et" //导入ET服务模块
6 "github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
7)
8
9func main() {
10 // 创建STS服务的Client对象,Endpoint使用默认值
11 AK, SK := <your-access-key-id>, <your-secret-access-key>
12 stsClient, err := sts.NewClient(AK, SK)
13 if err != nil {
14 fmt.Println("create sts client object :", err)
15 return
16 }
17
18 // 获取临时认证token,有效期为60秒,ACL为空
19 stsObj, err := stsClient.GetSessionToken(60, "")
20 if err != nil {
21 fmt.Println("get session token failed:", err)
22 return
23 }
24 fmt.Println(" GetSessionToken result:")
25 fmt.Println(" accessKeyId:", stsObj.AccessKeyId)
26 fmt.Println(" secretAccessKey:", stsObj.SecretAccessKey)
27 fmt.Println(" sessionToken:", stsObj.SessionToken)
28 fmt.Println(" createTime:", stsObj.CreateTime)
29 fmt.Println(" expiration:", stsObj.Expiration)
30 fmt.Println(" userId:", stsObj.UserId)
31
32 // 使用申请的临时STS创建ET服务的Client对象,Endpoint使用默认值
33 etClient, err := et.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "bcc.bj.baidubce.com")
34 if err != nil {
35 fmt.Println("create et client failed:", err)
36 return
37 }
38 stsCredential, err := auth.NewSessionBceCredentials(
39 stsObj.AccessKeyId,
40 stsObj.SecretAccessKey,
41 stsObj.SessionToken)
42 if err != nil {
43 fmt.Println("create sts credential object failed:", err)
44 return
45 }
46 etClient.Config.Credentials = stsCredential
47}
注意: 目前使用STS配置ET Client时,无论对应ET服务的Endpoint在哪里,STS的Endpoint都需配置为http://sts.bj.baidubce.com。上述代码中创建STS对象时使用此默认值。
配置HTTPS协议访问ET
ET支持HTTPS传输协议,您可以通过在创建ET Client对象时指定的Endpoint中指明HTTPS的方式,在ET GO SDK中使用HTTPS访问ET服务:
1// import "github.com/baidubce/bce-sdk-go/services/et"
2
3ENDPOINT := "https://bcc.bj.baidubce.com" //指明使用HTTPS协议
4AK, SK := <your-access-key-id>, <your-secret-access-key>
5etClient, _ := et.NewClient(AK, SK, ENDPOINT)
配置ET Client
如果用户需要配置ET Client的一些细节的参数,可以在创建ET Client对象之后,使用该对象的导出字段Config
进行自定义配置,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问ET服务:
1// import "github.com/baidubce/bce-sdk-go/services/et"
2
3//创建ET Client对象
4AK, SK := <your-access-key-id>, <your-secret-access-key>
5ENDPOINT := "bcc.bj.baidubce.com"
6client, _ := et.NewClient(AK, SK, ENDPOINT)
7
8//代理使用本地的8080端口
9client.Config.ProxyUrl = "127.0.0.1:8080"
设置网络参数
用户可以通过如下的示例代码进行网络参数的设置:
1// import "github.com/baidubce/bce-sdk-go/services/et"
2
3AK, SK := <your-access-key-id>, <your-secret-access-key>
4ENDPOINT := "bcc.bj.baidubce.com"
5client, _ := et.NewClient(AK, SK, ENDPOINT)
6
7// 配置不进行重试,默认为Back Off重试
8client.Config.Retry = bce.NewNoRetryPolicy()
9
10// 配置连接超时时间为30秒
11client.Config.ConnectionTimeoutInMillis = 30 * 1000
配置生成签名字符串选项
1// import "github.com/baidubce/bce-sdk-go/services/et"
2
3AK, SK := <your-access-key-id>, <your-secret-access-key>
4ENDPOINT := "bcc.bj.baidubce.com"
5client, _ := et.NewClient(AK, SK, ENDPOINT)
6
7// 配置签名使用的HTTP请求头为`Host`
8headersToSign := map[string]struct{}{"Host": struct{}{}}
9client.Config.SignOption.HeadersToSign = HeadersToSign
10
11// 配置签名的有效期为30秒
12client.Config.SignOption.ExpireSeconds = 30
参数说明
用户使用GO SDK访问ET时,创建的ET 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创建ET Client”小节。SignOption
字段为生成签名字符串时的选项,详见下表说明:
名称 |
类型 |
含义 |
---|---|---|
HeadersToSign | map[string]struct{} | 生成签名字符串时使用的HTTP头 |
Timestamp | int64 | 生成的签名字符串中使用的时间戳,默认使用请求发送时的值 |
ExpireSeconds | int | 签名字符串的有效期 |
1 其中,HeadersToSign默认为`Host`,`Content-Type`,`Content-Length`,`Content-MD5`;TimeStamp一般为零值,表示使用调用生成认证字符串时的时间戳,用户一般不应该明确指定该字段的值;ExpireSeconds默认为1800秒即30分钟。
Retry
字段指定重试策略,目前支持两种:NoRetryPolicy
和BackOffRetryPolicy
。默认使用后者,该重试策略是指定最大重试次数、最长重试时间和重试基数,按照重试基数乘以2的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。
ET
申请物理专线
函数声明
1func (c *Client) CreateEtDcphy(args *CreateEtDcphyArgs) (*CreateEtDcphyResult, error) {
2 ......
3}
参数说明
请参考OpenAPI文档:申请物理专线参数说明
返回值
- 操作成功
1{
2 "id": "dcphy-gq65bz9ip712"
3}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_create_et.go
查询专线列表
函数声明
1func (c *Client) ListEtDcphy(args *ListEtDcphyArgs) (*ListEtDcphyResult, error) {
2 ......
3}
参数说明
请参考OpenAPI文档:查询专线列表参数说明
返回值
- 操作成功
1{
2 "nextMarker": "dcphy-gq65bz9ip712",
3 "marker": "dcphy-gq65bz9ie712",
4 "maxKeys": 1,
5 "isTruncated": true,
6 "ets": [{
7 "id": "dcphy-jy1sbnx32ez0",
8 "name": "et_6",
9 "description": "描述",
10 "status": "established",
11 "expireTime": "2019-01-30T08:50:00Z",
12 "isp": "ISP_CTC",
13 "intfType": "10G",
14 "apType": "BAIDU",
15 "apAddr": "BB",
16 "userName": "张三",
17 "userPhone": "133*****333",
18 "userEmail": "1***@123.com",
19 "userIdc": "北京|市辖区|东城区|2321"
20 "tags": []
21 }]
22}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_list_et.go
查询专线详情
函数声明
1func (c *Client) ListEtDcphyDetail(dcphyId string) (*EtDcphyDetail, error) {
2 ......
3}
参数说明
请参考OpenAPI文档:查询专线详情参数说明
返回值
- 操作成功
1{
2 "id": "dcphy-gq65bz9ip712",
3 "name": "ZX051501-testET",
4 "description": "",
5 "status": "established",
6 "expireTime": 1,
7 "isp": "ISP_CUCC",
8 "intfType": "10G",
9 "apType": "SINGLE",
10 "apAddr": "WHGG",
11 "userName": "张三",
12 "userPhone": "133*****333",
13 "userEmail": "1***@123.com",
14 "userIdc": "北京|市辖区|东城区|百度科技园K2"
15 "tags":[]
16}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_list_et_detail.go
更新物理专线
函数声明
1func (c *Client) UpdateEtDcphy(dcphyId string, args *UpdateEtDcphyArgs) error {
2 ......
3}
参数说明
请参考OpenAPI文档:更新物理专线参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_update_et.go
新建专线通道
函数声明
1func (c *Client) CreateEtChannel(args *CreateEtChannelArgs) (*CreateEtChannelResult, error) {
2 ......
3}
参数说明
请参考OpenAPI文档:新建专线通道参数说明
返回值
- 操作成功
1 {
2 "id": "dedicatedconn-zy9t7n91k0iq"
3 }
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_create_et_channel.go
查询专线通道
函数声明
1func (c *Client) GetEtChannel(args *GetEtChannelArgs) (*EtChannelResult, error) {
2 ......
3}
参数说明
请参考OpenAPI文档:查询专线通道参数说明
返回值
- 操作成功
1 {
2 "etChannels": [
3 {
4 "authorizedUsers": [
5 "8770xxxxxxxxxxxxxxxxxxxxxxx4df8"
6 ],
7 "description": "",
8 "baiduAddress": "11.11.11.21/24",
9 "name": "channel_name",
10 "bgpAsn": "45084",
11 "bgpKey": "7kab824",
12 "customerAddress": "11.11.11.12/24",
13 "routeType": "bgp",
14 "vlanId": 56,
15 "id":"dedicatedconn-zy9t7n91k0iq",
16 "status":"building",
17 "enableIpv6": 1,
18 "baiduIpv6Address": "2400:da00:e003:0:1eb:200::1/88",
19 "customerIpv6Address": "2400:da00:e003:0:0:200::1/88"
20 "tags": []
21 }
22 ]
23 }
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_get_et_channel.go
重新提交专线通道
函数声明
1func (c *Client) RecommitEtChannel(args *RecommitEtChannelArgs) error {
2 ......
3}
参数说明
请参考OpenAPI文档:重新提交专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_recommit_et_channel.go
更新专线通道
函数声明
1func (c *Client) UpdateEtChannel(args *UpdateEtChannelArgs) error {
2 ......
3}
参数说明
请参考OpenAPI文档:更新专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_update_et_channel.go
删除专线通道
函数声明
1func (c *Client) DeleteEtChannel(args *DeleteEtChannelArgs) error {
2 ......
3}
参数说明
请参考OpenAPI文档:删除专线通道参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_delete_et_channel.go
打开专线通道的IPv6功能
函数声明
1func (c *Client) EnableEtChannelIPv6(args *EnableEtChannelIPv6Args) error {
2 ......
3}
参数说明
请参考OpenAPI文档:打开专线通道的IPv6功能参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:examples_enable_channel_ipv6.go
关闭专线通道IPv6功能
函数声明
1func (c *Client) DisableEtChannelIPv6(args *DisableEtChannelIPv6Args) error {
2 ......
3}
参数说明
请参考OpenAPI文档:关闭专线通道IPv6功能参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_disable_et_channel_ipv6.go
创建专线通道路由规则
函数声明
1func (c *Client) CreateEtChannelRouteRule(args *CreateEtChannelRouteRuleArgs) (*CreateEtChannelRouteRuleResult, error) {
2 ......
3}
参数声明
请参考OpenAPI文档:创建专线通道路由规则参数说明
返回值
- 操作成功
1{
2 "routeRuleId":"dcrr-5afcf643-94e"
3}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_create_et_channel_route_rule.go
查询专线通道路由规则
函数声明
1func ListEtChannelRouteRule() {
2 ......
3}
参数声明
请参考OpenAPI文档:查询专线通道路由规则参数说明
返回值
- 操作成功
1{
2 "nextMarker": "14eabc99-dce7-11ec-84d4-6c92bf29c398",
3 "maxKeys": 1,
4 "isTruncated": true,
5 "routeRules": [{
6 "routeRuleId": "dcrr-5afcf643-94e",
7 "ipVersion": 4,
8 "destAddress": "10.0.0.1/32",
9 "nexthopType": "etGateway"
10 "nexthopId": "dcgw-arc647h3014w",
11 "description": "route_1"
12 }]
13}
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_list_et_channel_route_rules.go
修改专线通道路由规则
函数声明
1func UpdateEtChannelRouteRule() {
2 ......
3}
参数声明
请参考OpenAPI文档:修改专线通道路由规则参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码
具体代码示例参考:example_update_et_channel_route_rule.go
删除专线通道路由规则
函数声明
1func DeleteEtChannelRouteRule() {
2 ......
3}
参数声明
请参考OpenAPI文档:删除专线通道路由规则参数说明
返回值
- 操作成功
无返回值
- 操作失败
操作失败返回异常列表参考:异常列表
示例代码