私有网络VPC

    VPC

    VPC服务

    概述

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

    初始化

    确认Endpoint

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

    获取密钥

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

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

    注册百度云账号

    创建AK/SK

    新建VPC Client

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

    使用AK/SK新建VPC Client

    通过AK/SK方式访问VPC,用户可以参考如下代码新建一个VPC 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>
    
    	// 初始化一个VpcClient
    	vpcClient, err := vpc.NewClient(AK, SK, ENDPOINT)
    }

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

    注意:ENDPOINT参数需要用指定区域的域名来进行定义,如服务所在区域为北京,则为http://bcc.bj.baidubce.com

    使用STS创建VPC Client

    申请STS token

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

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

    用STS token新建VPC Client

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

    代码示例

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

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

    配置HTTPS协议访问VPC

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

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

    配置VPC Client

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

    使用代理

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

    // import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    //创建VPC 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, _ := vpc.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, _ := vpc.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访问VPC时,创建的VPC 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.NewBceCredentialsauth.NewSessionBceCredentials函数创建,默认使用前者,后者为使用STS鉴权时使用,详见“使用STS创建VPC 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字段指定重试策略,目前支持两种:NoRetryPolicyBackOffRetryPolicy。默认使用后者,该重试策略是指定最大重试次数、最长重试时间和重试基数,按照重试基数乘以2的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。

    VPC管理

    私有网络(Virtual private Cloud,VPC) 是一个用户能够自定义的虚拟网络,能够帮助用户构建属于自己的网络环境。通过指定IP地址范围和子网等配置,即可快速创建一个VPC,不同的VPC之间完全隔离,用户可以在VPC内创建和管理BCC实例。

    创建VPC

    通过以下代码可以创建VPC实例:

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    args := &vpc.CreateVPCArgs{
    	// 设置创建vpc使用的名称
        Name:        "test-vpc",
        // 设置创建vpc使用的描述信息
        Description: "test-vpc-description",
        // 设置创建vpc使用的cidr
        Cidr:        "102.168.0.0/24",
        // 设置创建vpc使用的标签键值对列表
        Tags: []model.TagModel{
            {
                TagKey:   "tagK",
                TagValue: "tagV",
            },
        },
    }
    if result, err := client.CreateVPC(args); err != nil {
        fmt.Println("create vpc failed: ", err)
        return
    } 
    
    fmt.Println("create vpc success, vpc id: ", result.VPCID)

    注意: 对请求参数的内容解释如下

    • Name: 表示VPC名称,不能取值"default",长度不超过65个字符,可由数字,字符,下划线组成;
    • ClientToken: 表示幂等性Token,是一个长度不超过64位的ASCII字符串,详见ClientToken幂等性
    • Description: VPC描述,不超过200字符
    • Cidr: VPC的cidr
    • Tags: 待创建的标签键值对列表

    查询VPC列表

    使用以下代码查询VPC列表信息。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    args := &vpc.ListVPCArgs{
    	// 设置每页包含的最大数量,最大数量通常不超过1000,缺省值为1000
        MaxKeys: 2,
        // 设置批量获取列表的查询的起始位置,是一个由系统生成的字符串
        Marker:  marker,
        // 设置是否为默认VPC,可选值:true、false;当不填写此参数时返回所有VPC
        IsDefault: "false",
    }
    result, err := client.ListVPC(listArgs)
    if err != nil {
    	fmt.Println("list vpc error: ", err)
        return
    }
    
    // 返回标记查询的起始位置
    fmt.Println("vpc list marker: ", result.Marker)
    // true表示后面还有数据,false表示已经是最后一页
    fmt.Println("vpc list isTruncated: ", result.IsTruncated)
    // 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    fmt.Println("vpc list nextMarker: ", result.NextMarker)
    // 每页包含的最大数量
    fmt.Println("vpc list maxKeys: ", result.MaxKeys)
    // 获取vpc的具体信息
    for _, v := range result.VPCs {
        fmt.Println("vpc id: ", v.VPCID)
        fmt.Println("vpc name: ", v.Name)
        fmt.Println("vpc cidr: ", v.Cidr)
        fmt.Println("vpc description: ", v.Description)
        fmt.Println("vpc isDefault: ", v.IsDefault)
        fmt.Println("vpc secondaryCidr: ", v.SecondaryCidr)
        fmt.Println("vpc tags: ", v.Tags)
    }

    查询指定VPC

    根据特定的VPC ID可以查看相关VPC的详情信息。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    result, err := client.GetVPCDetail(vpcId)
    if err != nil {
    	fmt.Println("get vpc detail error: ", err)
        return 
    }
    
    // 查询得到vpc的id
    fmt.Println("VPC id: ", result.VPC.VPCId)
    // 查询得到vpc的名称
    fmt.Println("VPC name: ", result.VPC.Name)
    // 查询得到vpc的网段及子网掩码
    fmt.Println("VPC cidr: ", result.VPC.Cidr)
    // 查询得到vpc的描述
    fmt.Println("VPC description: ", result.VPC.Description)
    // 查询得到是否为默认vpc
    fmt.Println("VPC isDefault: ", result.VPC.IsDefault)
    // 查询得到vpc中包含的子网
    fmt.Println("VPC subnets: ", result.VPC.Subnets)
    // 查询得到vpc的辅助网段cidr列表
    fmt.Println("VPC secondaryCidr: ", result.VPC.SecondaryCidr)

    查询得到的VPC详情信息包括名称、网段、描述等信息。

    删除VPC

    使用以下代码可以删除特定的VPC。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    if err := client.DeleteVPC(vpcId, clientToken); err != nil {
        fmt.Println("delete vpc error: ", err)
        return 
    }
    
    fmt.Printf("delete vpc %s success.", vpcId)

    注意: 参数中的clientToken表示幂等性Token,是一个长度不超过64位的ASCII字符串,详见ClientToken幂等性

    更新VPC

    使用以下代码可以更新指定VPC的名称和描述信息。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    args := &vpc.UpdateVPCArgs{
    	// 设置vpc的新名称
        Name:        "TestVPCUpdate",
        // 设置vpc的新备注
        Description: "Test VPC description update",
        // 设置幂等性Token
        ClientToken: clientToken,
    }
    if err := client.UpdateVPC(vpcId, args); err != nil {
        fmt.Println("update vpc error: ", err)
        return
    }
    
    fmt.Printf("update vpc %s success.", vpcId)

    注意: 更新VPC时,对name和description字段的规范要求参考创建VPC一节。

    上一篇
    异常处理
    下一篇
    子网