私有网络VPC

    子网

    初始化

    确认Endpoint

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

    获取密钥

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

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

    注册百度云账号

    创建AK/SK

    新建Subnet Client

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

    使用AK/SK新建Subnet Client

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

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

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

    使用STS创建Subnet Client

    申请STS token

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

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

    用STS token新建subnet Client

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

    代码示例

    GO SDK实现了STS服务的接口,用户可以参考如下完整代码,实现申请STS Token和创建Subnet 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使用默认值
    	subnetClient, 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
    	}
    	subnetClient.Config.Credentials = stsCredential
    }

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

    配置HTTPS协议访问子网

    子网支持HTTPS传输协议,您可以通过在创建Subnet Client对象时指定的Endpoint中指明HTTPS的方式,在Subnet 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>
    subnetClient, _ := vpc.NewClient(AK, SK, ENDPOINT)

    配置Subnet Client

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

    使用代理

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

    // import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    //创建Subnet 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访问子网时,创建的Subnet 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创建Subnet 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 内的用户可定义的IP地址范围,根据业务需求,通过CIDR(无类域间路由)可以指定不同的地址空间和IP段。未来用户可以将子网作为一个单位,用来定义Internet访问权限、路由规则和安全策略。

    创建子网

    通过以下代码可以在指定VPC中创建子网。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    args := &vpc.CreateSubnetArgs{
    	// 设置子网的名称
        Name:        "TestSDK-Subnet",
        // 设置子网的可用区名称
        ZoneName:    "cn-bj-a",
        // 设置子网的cidr
        Cidr:        "192.168.1.0/24",
        // 设置子网所属vpc的id
        VpcId:       "vpc-4njbqurm0uag",
        // 设置子网的类型,包括“BCC”、“BCC_NAT”、“BBC”三种
        SubnetType:  vpc.SUBNET_TYPE_BCC,
        // 设置子网的描述
        Description: "test subnet",
        // 设置子网的标签键值对列表
        Tags: []model.TagModel{
            {
                TagKey:   "tagK",
                TagValue: "tagV",
            },
        },
    }
    result, err := client.CreateSubnet(args)
    if err != nil {
        fmt.Println("create subnet error: ", err)
        return
    }
    
    fmt.Println("create subnet success, subnet id: ", result.SubnetId)

    注意:

    • 子网名称,不能取值"default",长度不超过65个字符,可由数字,字符,下划线组成
    • 可用区名称, 其查询方式参考查询可用区列表

    查询子网列表

    使用以下代码可以查询符合条件的子网列表。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    args := &vpc.ListSubnetArgs{
    	// 设置批量获取列表的查询的起始位置,是一个由系统生成的字符串
    	Marker:     marker,
    	// 设置每页包含的最大数量,最大数量通常不超过1000。缺省值为1000
    	MaxKeys:    maxKeys,
    	// 设置所属vpc的id
        VpcId:      vpcId,
        // 设置所属可用区的名称
        ZoneName:   zoneName,
        // 设置子网类型
        SubnetType: vpc.SUBNET_TYPE_BCC,
    }
    result, err := client.ListSubnets(args)
    if err != nil {
        fmt.Println("list subnets error: ", err)
        return 
    }
    
    // 返回标记查询的起始位置
    fmt.Println("subnet list marker: ", result.Marker)
    // true表示后面还有数据,false表示已经是最后一页
    fmt.Println("subnet list isTruncated: ", result.IsTruncated)
    // 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    fmt.Println("subnet list nextMarker: ", result.NextMarker)
    // 每页包含的最大数量
    fmt.Println("subnet list maxKeys: ", result.MaxKeys)
    // 获取subnet的具体信息
    for _, sub := range result.Subnets {
        fmt.Println("subnet id: ", sub.SubnetId)
        fmt.Println("subnet name: ", sub.Name)
        fmt.Println("subnet zoneName: ", sub.ZoneName)
        fmt.Println("subnet cidr: ", sub.Cidr)
        fmt.Println("subnet vpcId: ", sub.VPCId)
        fmt.Println("subnet subnetType: ", sub.SubnetType)
        fmt.Println("subnet description: ", sub.Description)
        fmt.Println("subnet availableIp: ", sub.AvailableIp)
        fmt.Println("subnet tags: ", sub.Tags)
    }

    根据该API,可以根据vpcId、zoneName、subnetType等条件查询符合要求的子网列表。

    查询指定子网

    根据以下代码可以查询指定子网的详细信息。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    result, err := client.GetSubnetDetail(subnetId)
    if err != nil {
        fmt.Println("get subnet detail error: ", err)
        return 
    }
    
    // 查询得到子网的id
    fmt.Println("subnet id: ", result.Subnet.SubnetId)
    // 查询得到子网的名称
    fmt.Println("subnet name: ", result.Subnet.Name)
    // 查询得到子网所属可用区的名称
    fmt.Println("subnet zoneName: ", result.Subnet.ZoneName)
    // 查询得到子网的cidr
    fmt.Println("subnet cidr: ", result.Subnet.Cidr)
    // 查询得到子网所属vpc的id
    fmt.Println("subnet vpcId: ", result.Subnet.VPCId)
    // 查询得到子网的类型
    fmt.Println("subnet subnetType: ", result.Subnet.SubnetType)
    // 查询得到子网的描述
    fmt.Println("subnet description: ", result.Subnet.Description)
    // 查询得到子网内可用ip数
    fmt.Println("subnet availableIp: ", result.Subnet.AvailableIp)
    // 查询得到子网绑定的标签列表
    fmt.Println("subnet tags: ", result.Subnet.Tags)

    通过该接口可以得到子网的名称、可用区、cidr、类型、描述、可用ip数、标签列表等信息。

    注意: 子网类型包括"BCC”、"BCC_NAT”、”BBC”三种。

    删除子网

    通过以下代码可以删除指定子网。

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

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

    更新子网

    使用以下代码可以更新子网信息。

    //import "github.com/baidubce/bce-sdk-go/services/vpc"
    
    args := &vpc.UpdateSubnetArgs{
    	// 设置更新操作使用的幂等性token
        ClientToken: clientToken,
        // 设置更新后的子网名称
        Name:        "TestSDK-Subnet-update",
        // 设置更新后的子网描述
        Description: "subnet update",
    }
    if err := client.UpdateSubnet(subnetId, args); err != nil {
        fmt.Println("update subnet error: ", err)
        return
    }
    
    fmt.Printf("update subnet %s success.", subnetId)

    使用该接口可以实现对子网名称和描述信息的更新操作。

    上一篇
    VPC
    下一篇
    ACL