子网

更新时间：2024-01-12

初始化

确认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分钟

说明：

Credentials字段使用auth.NewBceCredentials与auth.NewSessionBceCredentials函数创建，默认使用前者，后者为使用STS鉴权时使用，详见“使用STS创建Subnet 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的指数级增长的方式进行重试，直到达到最大重试测试或者最长重试时间为止。

子网管理

子网是 VPC 内的用户可定义的IP地址范围，根据业务需求，通过CIDR(无类域间路由)可以指定不同的地址空间和IP段。未来用户可以将子网作为一个单位，用来定义Internet访问权限、路由规则和安全策略。

创建子网

函数声明

type CreateSubnetArgs struct {
	ClientToken      string           `json:"-"`
	Name             string           `json:"name"`
	ZoneName         string           `json:"zoneName"`
	Cidr             string           `json:"cidr"`
	VpcId            string           `json:"vpcId"`
	VpcSecondaryCidr string           `json:"vpcSecondaryCidr,omitempty"`
	SubnetType       SubnetType       `json:"subnetType,omitempty"`
	Description      string           `json:"description,omitempty"`
	EnableIpv6       bool             `json:"enableIpv6,omitempty"`
	Tags             []model.TagModel `json:"tags,omitempty"`
}
func (c *Client) CreateSubnet(args *CreateSubnetArgs) (*CreateSubnetResult, error)

参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/Yjwvyu8o1

使用示例

createSubnetArgs := &vpc.CreateSubnetArgs{
    Name:        "TestSDK-Subnet",   // 子网名称
    Description: "vpc test",         // 子网描述
    Cidr:        "192.168.96.0/20",  // 子网网段
    VpcId:       "vpc-p1eawhw5rx4n", // vpc id
    ZoneName:    "cn-bj-a",          // 子网可用区
}
response, err := client.CreateSubnet(createSubnetArgs) // 创建子网

返回值
操作成功：

{
    "subnetId":"sbn-1A09ef6b"
}

操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_create_subnet.go

列举子网

函数声明

type ListSubnetArgs struct {
	Marker     string
	MaxKeys    int
	VpcId      string
	ZoneName   string
	SubnetType SubnetType
}

func (c *Client) ListSubnets(args *ListSubnetArgs) (*ListSubnetResult, error)

参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/xjwvyu8zu

使用示例

args := &vpc.ListSubnetArgs{
    MaxKeys: 100,                // 设置每页包含的最大数量，最大数量通常不超过1000。缺省值为1000
    Marker:  "",                 // 设置批量获取列表的查询的起始位置，是一个由系统生成的字符串
    VpcId:   "vpc-p1eawhw5rx4n", // 子网所属vpc id
}

response, err := client.ListSubnets(args)

返回值
操作成功：

{
    "nextMarker": "sbn-IyarenI7",
    "marker": "sbn-IyWRnII7",
    "maxKeys": 1,
    "isTruncated": true,
    "subnets": [
        {
          "name": "系统预定义子网",
        	"subnetId": "sbn-IyWRnII7",
        	"zoneName": "cn-bj-a",
        	"cidr": "192.168.0.0/20",
            "ipv6Cidr": "",
        	"vpcId": "vpc-IyrqYIQ7",
        	"subnetType": "BCC",
        	"description": "",
            "createdTime": "2020-11-19T12:46:01Z",
        	"tags": [
                  {
                    "tagKey": "aa",
                    "tagValue": "bb"
                  }
              ]
        }
    ]
}

操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_list_subnet.go

查询子网

函数声明

func (c *Client) GetSubnetDetail(subnetId string) (*GetSubnetDetailResult, error)

参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/Sjwvyu89a

使用示例

subnetID := "sbn-u166vdnqqubi" // 子网id
response, err := client.GetSubnetDetail(subnetID) // 获取子网详情

返回值
操作成功：

{     
    "subnet":     
        {
            "name": "系统预定义子网",
        	"subnetId": "sbn-IyWRnII7",
        	"zoneName": "cn-bj-a",
        	"cidr": "192.168.0.0/20",
            "ipv6Cidr": "",
        	"vpcId": "vpc-IyrqYIQ7",
        	"subnetType": "BCC",
            "availableIp": 4090,
        	"description": "",
            "createdTime": "2020-11-19T12:46:01Z"
        } 
}

操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_get_subnet.go

更新子网

函数声明

type UpdateSubnetArgs struct {
	ClientToken string `json:"-"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	EnableIpv6  bool   `json:"enableIpv6"`
}
func (c *Client) UpdateSubnet(subnetId string, args *UpdateSubnetArgs) error

参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/3jwvyu7wm

使用示例

updateSubnetArgs := &vpc.UpdateSubnetArgs{
    ClientToken: clientToken,
    Name:        "test_subnet", // 更新子网名称
    Description: "",            // 更新子网描述
}
err := client.UpdateSubnet(subnetID, updateSubnetArgs) // 更新子网

返回值
操作成功：

{
}

操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_update_subnet.go

注意：只允许更新子网的name和description字段，cidr、zone_name和type字段不能更新

删除子网

函数声明

func (c *Client) DeleteSubnet(subnetId string, clientToken string) error

参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/6jwvyu9b8

使用示例

subnetID := "sbn-5uj2t9f1jazj"                   
clientToken := "be31b98c-5141-4838-9830-9be700de5a20"
err := client.DeleteSubnet(subnetID, clientToken)

返回值
操作成功：

{
}

操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_delete_subnet.go

创建预留网段

使用以下代码可以创建路由规则

函数声明

func (c *Client) CreateIpreserve(args *CreateIpreserveArgs) (*CreateIpreserveResult, error)

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/xlgyjw2kn

返回值

操作成功：

{
　　"ipReserveId":"ipr-te2pa9cv4ikk"
}

操作失败：

返回错误，错误代码列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7

代码示例

具体代码示例参考： example_create_ip_reserve.go

查询预留网段列表

使用以下代码可以创建路由规则

函数声明

func (c *Client) ListIpreserve(args *ListIpeserveArgs) (*ListIpeserveResult, error)

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/xlgyjw2kn

返回值

操作成功：

{
   "marker": "",
   "nextMarker": "ipr-7xp6wvzqpmhd",
   "maxKeys": 1,
   "isTruncated": true,
   "ipReserves":[
        {
            "ipReserveId":"ipr-tqsbpf5hcvbp",
            "subnetId":"sbn-a4cikyt7756r",
            "ipCidr":"192.168.0.200/30",
            "ipVersion":"4",
            "description":"test",
            "createdTime":"2023-04-27T03:44:38Z",
            "updatedTime":"2023-04-27T03:45:38Z"
        }
    ]
}

操作失败：

返回错误，错误代码列表参考：https://cloud.baidu.com/doc/VPC/s/Flgyjya1o

代码示例

具体代码示例参考： example_list_ip_reserve.go

删除预留网段

使用以下代码可以创建路由规则

函数声明

func (c *Client) DeleteIpreserve(ipReserveId, clientToken string) error

参数含义

请参考OpenAPI文档：https://cloud.baidu.com/doc/VPC/s/xlgyjw2kn

返回值

操作成功：

{}

操作失败：

返回错误，错误代码列表参考：https://cloud.baidu.com/doc/VPC/s/6lgyjz8jn

代码示例

具体代码示例参考： example_delete_ip_reserve.go

VPC

ACL

百度智能云

私有网络 VPC

私有网络 VPC

子网

初始化

确认Endpoint

获取密钥

新建Subnet Client

使用AK/SK新建Subnet Client

使用STS创建Subnet Client

配置HTTPS协议访问子网

配置Subnet Client

使用代理

设置网络参数

配置生成签名字符串选项

子网管理

创建子网

列举子网

查询子网

更新子网

删除子网

创建预留网段

函数声明

参数含义

返回值

代码示例

查询预留网段列表

函数声明

参数含义

返回值

代码示例

删除预留网段

函数声明

参数含义

返回值

代码示例