网络探测
初始化
确认Endpoint
在确认您使用SDK配置Endpoint时,可先阅读开发人员指南中关于VPC服务域名的部分,理解Endpoint相关的概念。 百度智能云目前开放了多区域支持,请参考区域选择说明中网络产品VPC的部分,网络探测服务是VPC服务的一部分,使用VPC服务域名。
获取密钥
要使用百度云产品,您需要拥有一个百度云账号和一个有效的 AK(Access Key ID)、SK(Secret Access Key)用来进行签名认证。
可以通过如下步骤获得并了解您的AK/SK信息:
获取到密钥后,需要在配置Client时做为参数填入。SDK集成了鉴权认证机制,您不需要关心鉴权背后的运算方法,只需要将AK/SK按要求填入对应的位置,SDK将自动为您完成鉴权相关的工作。
新建Probe Client
Probe Client是网络探测服务的客户端,为开发者与网络探测服务进行交互提供了一系列的方法。
使用AK/SK新建Probe Client
通过AK/SK方式访问网络探测,用户可以参考如下代码新建一个Probe 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>
// 初始化一个Probe Client
probeClient, 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创建Probe Client
申请STS token
网络探测可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。
通过STS方式访问网络探测,用户需要先通过STS的client申请一个认证字符串。
用STS token新建Probe Client
申请好STS后,可将STS Token配置到Probe Client中,从而实现通过STS Token创建Probe Client。
代码示例
GO SDK实现了STS服务的接口,用户可以参考如下完整代码,实现申请STS Token和创建Probe 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创建网络探测服务的Client对象,Endpoint使用默认值
probeClient, err := vpc.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "bcc.bj.baidubce.com")
if err != nil {
fmt.Println("create Probe 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
}
probeClient.Config.Credentials = stsCredential
}
注意: 目前使用STS配置Probe Client时,无论对应网络探测服务的Endpoint在哪里,STS的Endpoint都需配置为http://sts.bj.baidubce.com。 上述代码中创建STS对象时使用此默认值。
配置HTTPS协议访问网络探测
网络探测支持HTTPS传输协议,您可以通过在创建Probe Client对象时指定的Endpoint中指明HTTPS的方式,在Probe GO SDK中使用HTTPS访问网络探测服务:
// 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>
probeClient, _ := vpc.NewClient(AK, SK, ENDPOINT)
配置Probe Client
如果用户需要配置Probe Client的一些细节的参数,可以在创建Probe Client对象之后,使用该对象的导出字段Config
进行自定义配置,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问网络探测服务:
// import "github.com/baidubce/bce-sdk-go/services/vpc"
//创建Probe Client对象
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "bcc.bj.baidubce.com"
probeClient, _ := vpc.NewClient(AK, SK, ENDPOINT)
//代理使用本地的8080端口
probeClient.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"
probeClient, _ := vpc.NewClient(AK, SK, ENDPOINT)
// 配置不进行重试,默认为Back Off重试
probeClient.Config.Retry = bce.NewNoRetryPolicy()
// 配置连接超时时间为30秒
probeClient.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"
probeClient, _ := vpc.NewClient(AK, SK, ENDPOINT)
// 配置签名使用的HTTP请求头为`Host`
headersToSign := map[string]struct{}{"Host": struct{}{}}
probeClient.Config.SignOption.HeadersToSign = HeadersToSign
// 配置签名的有效期为30秒
probeClient.Config.SignOption.ExpireSeconds = 30
参数说明
用户使用GO SDK访问网络探测时,创建的Probe 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创建Probe 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的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。
网络探测管理
创建网络探测
使用以下代码创建网络探测。
函数声明
type CreateProbeArgs struct {
ClientToken string `json:"-"`
Name string `json:"name"`
VpcId string `json:"vpcId"`
SubnetId string `json:"subnetId"`
Protocol string `json:"protocol"`
Frequency int `json:"frequency"`
DestIp string `json:"destIp"`
DestPort string `json:"destPort"`
SourceIps []string `json:"sourceIps"`
SourceIpNum int `json:"sourceIpNum,omitempty"`
Description string `json:"description,omitempty"`
Payload string `json:"payload,omitempty"`
}
type CreateProbeResult struct {
ProbeId string `json:"probeId"`
}
func (c *Client) CreateProbe(args *CreateProbeArgs) (*CreateProbeResult, error)
参数含义
请参考OpenAPI文档: https://cloud.baidu.com/doc/VPC/s/Xl6a5e196
返回值
- 操作成功:
{
"probeId": "probe-s2kyrsdnvk287ziu",
}
- 操作失败:
抛出异常,异常列表参考:异常列表
代码示例
具体代码示例参考:example_create_probe.go
查询网络探测列表
使用以下代码可以查询网络探测的列表信息。
函数声明
type ListProbesArgs struct {
Marker string
MaxKeys int
}
type Probe struct {
ProbeId string `json:"probeId"`
Name string `json:"name"`
VpcId string `json:"vpcId"`
SubnetId string `json:"subnetId"`
Protocol string `json:"protocol"`
Frequency int `json:"frequency"`
DestIp string `json:"destIp"`
DestPort string `json:"destPort"`
SourceIps []string `json:"sourceIps"`
SourceIpNum int `json:"sourceIpNum,omitempty"`
Description string `json:"description,omitempty"`
Payload string `json:"payload,omitempty"`
}
type ListProbesResult struct {
Probes []Probe `json:"probes"`
Marker string `json:"marker"`
IsTruncated bool `json:"isTruncated"`
NextMarker string `json:"nextMarker"`
MaxKeys int `json:"maxKeys"`
}
func (c *Client) ListProbes(args *ListProbesArgs) (*ListProbesResult, error)
使用该接口可以查询得到所有符合条件的网络探测信息。
参数含义
请参考OpenAPI文档:https://cloud.baidu.com/doc/VPC/s/Ul6lld6c5
返回值
- 操作成功:
{
"nextMarker": "probe-68sfxk5ihf85hjs",
"marker": "probe-6gfqbgfypumvmyh0",
"maxKeys": 1,
"isTruncated": true,
"probes": [
{
"description":"dsdsds",
"destIp":"1.2.3.4",
"destPort":11,
"frequency":20,
"name":"probe1",
"payload":"qqqqqqwwwww",
"probeId":"probe-6gfqbgfypumvmyh0",
"protocol":"UDP",
"sourceIps":[
"192.168.0.4"
],
"status":"active",
"subnetId":"sbn-qz55vemw0n40",
"vpcId":"vpc-2pa2x0bjt26i"
}
]
}
- 操作失败:
抛出异常,异常列表参考:异常列表
代码示例
具体代码示例参考:example_list_probes.go
查看网络探测详情
通过以下代码可以查询指定网络探测的详细信息。
函数声明
type Probe struct {
ProbeId string `json:"probeId"`
Name string `json:"name"`
VpcId string `json:"vpcId"`
SubnetId string `json:"subnetId"`
Protocol string `json:"protocol"`
Frequency int `json:"frequency"`
DestIp string `json:"destIp"`
DestPort string `json:"destPort"`
SourceIps []string `json:"sourceIps"`
SourceIpNum int `json:"sourceIpNum,omitempty"`
Description string `json:"description,omitempty"`
Payload string `json:"payload,omitempty"`
}
func (c *Client) GetProbeDetail(probeId string) (*Probe, error)
参数含义
请参考OpenAPI文档:https://cloud.baidu.com/doc/VPC/s/5l6lt3w4d
返回值
- 操作成功:
{
"probeId":"probe-6gfqbgfypumvmyh0",
"description":"dsdsds",
"destIp":"1.2.3.4",
"destPort":11,
"frequency":20,
"name":"probe1",
"payload":"qqqqqqwwwww",
"protocol":"UDP",
"sourceIps":[
"192.168.0.4"
],
"status":"active",
"subnetId":"sbn-qz55vemw0n40",
"vpcId":"vpc-2pa2x0bjt26i"
}
- 操作失败:
抛出异常,异常列表参考:异常列表
代码示例
具体代码示例参考:example_get_probe_detail.go
更新网络探测
使用以下代码可以更新指定网络探测的信息。
函数声明
type UpdateProbeArgs struct {
ClientToken string `json:"-"`
Name string `json:"name,omitempty"`
Frequency int `json:"frequency,omitempty"`
DestIp string `json:"destIp,omitempty"`
DestPort string `json:"destPort,omitempty"`
Description string `json:"description,omitempty"`
Payload string `json:"payload,omitempty"`
}
type UpdateProbeResult struct {
ProbeId string `json:"probeId"`
}
func (c *Client) UpdateProbe(probeId string, args *UpdateProbeArgs) error
参数含义
请参考OpenAPI文档:https://cloud.baidu.com/doc/VPC/s/dl6lu4bl8
返回值
- 操作成功:
无特殊返回参数
- 操作失败:
抛出异常,异常列表参考:异常列表
代码示例
具体代码示例参考:example_update_probe.go
删除网络探测
使用以下代码可以删除指定的网络探测。
函数声明
func (c *Client) DeleteProbe(probeId string, clientToken string) error
参数含义
请参考OpenAPI文档:https://cloud.baidu.com/doc/VPC/s/cl6ll9ur9
返回值
- 操作成功:
无特殊返回参数
- 操作失败:
抛出异常,异常列表参考:异常列表
代码示例
具体代码示例参考:example_delete_probe.go