Skip to content

Latest commit

 

History

History
667 lines (510 loc) · 19 KB

CSN.md

File metadata and controls

667 lines (510 loc) · 19 KB
Raw

CSN服务

概述

本文档主要介绍CSN GO SDK的使用。在使用本文档前，您需要先了解CSN的一些基本知识，并已开通了CSN服务。若您还不了解CSN，可以参考产品描述和操作指南 。

初始化

确认Endpoint

云智能网 API 的服务域名为：csn.baidubce.com

API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性，建议通过HTTPS调用。

获取密钥

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

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

注册百度云账号

创建AK/SK

新建CSN Client

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

使用AK/SK新建CSN Client

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

import (
	"github.com/baidubce/bce-sdk-go/services/csn"
)

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>

	// 初始化一个CSNClient
	csnClient, err := csn.NewClient(AK, SK, ENDPOINT)
}

在上面代码中，ACCESS_KEY_ID对应控制台中的“Access Key ID”，SECRET_ACCESS_KEY对应控制台中的“Access Key Secret”，获取方式请参考《操作指南 如何获取AKSK》。第三个参数ENDPOINT取值csn.baidubce.com，如果设置为空字符串，会使用默认域名作为CSN的服务地址。

使用STS创建CSN Client

申请STS token

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

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

用STS token新建CSN Client

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

代码示例

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

import (
	"fmt"

	"github.com/baidubce/bce-sdk-go/auth"         //导入认证模块
	"github.com/baidubce/bce-sdk-go/services/csn" //导入CSN服务模块
	"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创建CSN服务的Client对象，Endpoint使用默认值
	csnClient, err := csn.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "csn.baidubce.com")
	if err != nil {
		fmt.Println("create csn 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
	}
	csnClient.Config.Credentials = stsCredential
}

注意： 目前使用STS配置CSN Client时，STS的Endpoint需配置为http://sts.bj.baidubce.com。

配置HTTPS协议访问CSN

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

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

ENDPOINT := "https://csn.baidubce.com	" //指明使用HTTPS协议
AK, SK := <your-access-key-id>, <your-secret-access-key>
csnClient, _ := csn.NewClient(AK, SK, ENDPOINT)

配置CSN Client

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

使用代理

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

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

//创建CSN Client对象
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "csn.baidubce.com"
client, _ := csn.NewClient(AK, SK, ENDPOINT)

//代理使用本地的8080端口
client.Config.ProxyUrl = "127.0.0.1:8080"

设置网络参数

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

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

AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "csn.baidubce.com"
client, _ := csn.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/csn"

AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "csn.baidubce.com"
client, _ := csn.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访问CSN时，创建的CSN 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鉴权时使用，详见“使用STS创建CSN Client”小节。
  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的指数级增长的方式进行重试，直到达到最大重试测试或者最长重试时间为止。

主要接口

创建云智能网

desc := "desc"
args := &CreateCsnRequest{
    Name:        "csn_api_1",
    Description: &desc,
}

result, err := CsnClient.CreateCsn(args, getClientToken())
ExpectEqual(t.Errorf, nil, err)
CsnId := result.CsnId
log.Debug(CsnId)

更新云智能网

name := "csn_api_2"
args := &UpdateCsnRequest{
    Name:  &name,
}

err := CsnClient.UpdateCsn("csn-jf1tqjuvndzganap", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

删除云智能网

err := CsnClient.DeleteCsn("csn-jf1tqjuvndzganap", getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询云智能网列表

args := &ListCsnArgs{
    MaxKeys : 1,
    Marker: "csn-jf1tqjuvndzganap",
}
result, err := CsnClient.ListCsn(args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

查询云智能网详情

result, err := CsnClient.GetCsn("csn-3cq38gxc8irzuu0x")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

查询云智能网网络实例列表

args := &ListInstanceArgs{
    MaxKeys: 1,
    Marker: "tgwAttach-rvu8tkaubphb78eg",
}
result, err := CsnClient.ListInstance("csn-3cq38gxc8irzuu0x", args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

云智能网加载网络实例

args := &AttachInstanceRequest{
    InstanceId: "vpc-f7lkcxldfcwq",
    InstanceType: "bec_vpc",
    InstanceRegion: "cn-hangzhou-cm",
}
err := CsnClient.AttachInstance("csn-3cq38gxc8irzuu0x", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

云智能网卸载网络实例

args := &DetachInstanceRequest{
    InstanceId: "vpc-05y94xgfpujx",
    InstanceType: "vpc",
    InstanceRegion: "bj",
}
err := CsnClient.DetachInstance("csn-3cq38gxc8irzuu0x", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询路由表列表

args := &ListRouteTableArgs{}
result, err := CsnClient.ListRouteTable("csn-3cq38gxc8irzuu0x", args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

添加路由条目

args := &CreateRouteRuleRequest{
    AttachId: "tgwAttach-rvu8tkaubphb78eg",
    DestAddress: "0.0.0.0/0",
    RouteType: "custom",
}
err := CsnClient.CreateRouteRule("csnRt-qjv5vtzxf53qq3wr", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询路由条目

args := &ListRouteRuleArgs{}
result, err := CsnClient.ListRouteRule("csnRt-qjv5vtzxf53qq3wr", args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

删除路由条目

err := CsnClient.DeleteRouteRule("csnRt-qjv5vtzxf53qq3wr",
"7bb14cb1-fb02-4ae3-97d6-4e295338936c", getClientToken())
ExpectEqual(t.Errorf, nil, err)

创建学习关系

desc := "desc"
args := &CreatePropagationRequest{
    AttachId: "tgwAttach-uff0gvjkis95f6xg",
    Description: &desc,
}
err := CsnClient.CreatePropagation("csnRt-qjv5vtzxf53qq3wr", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询学习关系

result, err := CsnClient.ListPropagation("csnRt-qjv5vtzxf53qq3wr")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

删除学习关系

err := CsnClient.DeletePropagation("csnRt-qjv5vtzxf53qq3wr",
"tgwAttach-uff0gvjkis95f6xg", getClientToken())
ExpectEqual(t.Errorf, nil, err)

创建关联关系

desc := "desc"
args := &CreateAssociationRequest{
    AttachId: "tgwAttach-uff0gvjkis95f6xg",
    Description: &desc,
}
err := CsnClient.CreateAssociation("csnRt-qjv5vtzxf53qq3wr", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询关联关系

result, err := CsnClient.ListAssociation("csnRt-qjv5vtzxf53qq3wr")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

删除关联关系

err := CsnClient.DeleteAssociation("csnRt-qjv5vtzxf53qq3wr",
"tgwAttach-uff0gvjkis95f6xg", getClientToken())
ExpectEqual(t.Errorf, nil, err)

创建带宽包

instanceType := "center-edge"
args := &CreateCsnBpRequest{
    Name:  "csnBp_api_2",
    Bandwidth:     100,
    InterworkType: &instanceType,
    GeographicA: "China",
    GeographicB: "China",
    Billing: Billing{
        PaymentTiming: "Postpaid",
    },
}
result, err := CsnClient.CreateCsnBp(args, getClientToken())
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

更新带宽包

args := &UpdateCsnBpRequest{
    Name: "csnBp_api_2",
}
err := CsnClient.UpdateCsnBp("csnBp-nyfb3wn198y7", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

删除带宽包

err := CsnClient.DeleteCsnBp("csnBp-d51bzt2ah6ka", getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询带宽包列表

args := &ListCsnBpArgs{}
result, err := CsnClient.ListCsnBp(args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

查询指定带宽包详情

result, err := CsnClient.GetCsnBp("csnBp-nyfb3wn198y7")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

带宽包的带宽升降级

args := &ResizeCsnBpRequest{
    Bandwidth: 200,
}
err := CsnClient.ResizeCsnBp("csnBp-nyfb3wn198y7", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

带宽包绑定云智能网

args := &BindCsnBpRequest{
    CsnId: "csn-3cq38gxc8irzuu0x",
}
err := CsnClient.BindCsnBp("csnBp-sj44m8xnq1z9", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

带宽包解绑云智能网

args := &UnbindCsnBpRequest{
    CsnId: "csn-3cq38gxc8irzuu0x",
}
err := CsnClient.UnbindCsnBp("csnBp-nyfb3wn198y7", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

创建地域带宽

args := &CreateCsnBpLimitRequest{
    LocalRegion: "bj",
    PeerRegion: "cn-hangzhou-cm",
    Bandwidth: 10,
}
err := CsnClient.CreateCsnBpLimit("csnBp-sj44m8xnq1z9", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

更新地域带宽

args := &UpdateCsnBpLimitRequest{
    LocalRegion: "bj",
    PeerRegion: "cn-hangzhou-cm",
    Bandwidth: 20,
}
err := CsnClient.UpdateCsnBpLimit("csnBp-sj44m8xnq1z9", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

删除地域带宽

args := &DeleteCsnBpLimitRequest{
    LocalRegion: "bj",
    PeerRegion: "cn-hangzhou-cm",
}
err := CsnClient.DeleteCsnBpLimit("csnBp-sj44m8xnq1z9", args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询地域带宽

result, err := CsnClient.ListCsnBpLimit("csnBp-sj44m8xnq1z9")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

查询指定云智能网的地域带宽

result, err := CsnClient.ListCsnBpLimitByCsnId("csn-3cq38gxc8irzuu0x")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

查询TGW列表

args := &ListTgwArgs{}
result, err := CsnClient.ListTgw("csn-3cq38gxc8irzuu0x", args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

更新TGW信息

name := "tgw_1"
desc := "desc"
args := &UpdateTgwRequest{
    Name: &name,
    Description: &desc,
}
err := CsnClient.UpdateTgw("csn-3cq38gxc8irzuu0x", "tgw-kyn0dc0e1qrvvaz5",
args, getClientToken())
ExpectEqual(t.Errorf, nil, err)

查询TGW路由条目

args := &ListTgwRuleArgs{}
result, err := CsnClient.ListTgwRule("csn-3cq38gxc8irzuu0x", "tgw-kyn0dc0e1qrvvaz5", args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

错误处理

GO语言以error类型标识错误，CSN支持两种错误见下表：

错误类型 说明
BceClientError 用户操作产生的错误
BceServiceError CSN服务返回的错误

用户使用SDK调用CSN相关接口，除了返回所需的结果之外还会返回错误，用户可以获取相关错误进行处理。实例如下：

args := &ListInstanceRequest{
    InstanceType: "eip",
}
result, err := CsnClient.ListInstance(args)
if err != nil {
	switch realErr := err.(type) {
	case *bce.BceClientError:
		fmt.Println("client occurs error:", realErr.Error())
	case *bce.BceServiceError:
		fmt.Println("service occurs error:", realErr.Error())
	default:
		fmt.Println("unknown error:", err)
	}
}

客户端异常

客户端异常表示客户端尝试向CSN发送请求以及数据传输时遇到的异常。例如，当发送请求时网络连接不可用时，则会返回BceClientError。

服务端异常

当CSN服务端出现异常时，CSN服务端会返回给用户相应的错误信息，以便定位问题。常见服务端异常可参见CSN错误码

SDK日志

CSN GO SDK支持六个级别、三种输出（标准输出、标准错误、文件）、基本格式设置的日志模块，导入路径为github.com/baidubce/bce-sdk-go/util/log。输出为文件时支持设置五种日志滚动方式（不滚动、按天、按小时、按分钟、按大小），此时还需设置输出日志文件的目录。

默认日志

CSN GO SDK自身使用包级别的全局日志对象，该对象默认情况下不记录日志，如果需要输出SDK相关日志需要用户自定指定输出方式和级别，详见如下示例：

// import "github.com/baidubce/bce-sdk-go/util/log"

// 指定输出到标准错误，输出INFO及以上级别
log.SetLogHandler(log.STDERR)
log.SetLogLevel(log.INFO)

// 指定输出到标准错误和文件，DEBUG及以上级别，以1GB文件大小进行滚动
log.SetLogHandler(log.STDERR | log.FILE)
log.SetLogDir("/tmp/gosdk-log")
log.SetRotateType(log.ROTATE_SIZE)
log.SetRotateSize(1 << 30)

// 输出到标准输出，仅输出级别和日志消息
log.SetLogHandler(log.STDOUT)
log.SetLogFormat([]string{log.FMT_LEVEL, log.FMT_MSG})

说明：

  1. 日志默认输出级别为DEBUG
  2. 如果设置为输出到文件，默认日志输出目录为/tmp，默认按小时滚动
  3. 如果设置为输出到文件且按大小滚动，默认滚动大小为1GB
  4. 默认的日志输出格式为：FMT_LEVEL, FMT_LTIME, FMT_LOCATION, FMT_MSG

项目使用

该日志模块无任何外部依赖，用户使用GO SDK开发项目，可以直接引用该日志模块自行在项目中使用，用户可以继续使用GO SDK使用的包级别的日志对象，也可创建新的日志对象，详见如下示例：

// 直接使用包级别全局日志对象（会和GO SDK自身日志一并输出）
log.SetLogHandler(log.STDERR)
log.Debugf("%s", "logging message using the log package in the CSN go sdk")

// 创建新的日志对象（依据自定义设置输出日志，与GO SDK日志输出分离）
myLogger := log.NewLogger()
myLogger.SetLogHandler(log.FILE)
myLogger.SetLogDir("/home/log")
myLogger.SetRotateType(log.ROTATE_SIZE)
myLogger.Info("this is my own logger from the CSN go sdk")