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信息：
新建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分钟 |
说明：
Credentials字段使用auth.NewBceCredentials与auth.NewSessionBceCredentials函数创建，默认使用前者，后者为使用STS鉴权时使用，详见“使用STS创建VPC 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管理
私有网络(Virtual private Cloud，VPC) 是一个用户能够自定义的虚拟网络，能够帮助用户构建属于自己的网络环境。通过指定IP地址范围和子网等配置，即可快速创建一个VPC，不同的VPC之间完全隔离，用户可以在VPC内创建和管理BCC实例。
创建VPC
函数声明
type CreateVPCArgs struct {
ClientToken string `json:"-"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Cidr string `json:"cidr"`
Tags []model.TagModel `json:"tags,omitempty"`
}
func (c *Client) CreateVPC(args *CreateVPCArgs) (*CreateVPCResult, error)参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/Njwvyuaq5
使用示例
createVpcArgs := &vpc.CreateVPCArgs{
Name: "TestSDK-VPC", // vpc名称
Description: "vpc test", // vpc描述
Cidr: "192.168.0.0/16", // vpc网段
Tags: []model.TagModel{ // vpc标签
{
TagKey: "tagK",
TagValue: "tagV",
},
},
}
response, err := client.CreateVPC(createVpcArgs)返回值
操作成功：
{
"subnetId":"sbn-1A09ef6b"
} 操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_create_vpc.go
查询VPC列表
函数声明
type ListVPCArgs struct {
Marker string
MaxKeys int
// IsDefault is a string type,
// so we can identify if it has been setted when the value is false.
// NOTE: it can be only true or false.
IsDefault string
}
func (c *Client) ListVPC(args *ListVPCArgs) (*ListVPCResult, error)参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/wjwvyub23
使用示例
args := &vpc.ListVPCArgs{
MaxKeys: 100, // 设置每页包含的最大数量，最大数量通常不超过1000。缺省值为1000
Marker: "", // 设置批量获取列表的查询的起始位置，是一个由系统生成的字符串
}
response, err := client.ListVPC(args) // 获取vpc列表返回值
操作成功：
{
"nextMarker": "vpc-xktdeMSf",
"marker": "vpc-IyWRtII7",
"maxKeys": 1,
"isTruncated": true,
"vpcs": [
{
"vpcId': "vpc-IyWRtII7",
"name": "VPC Name",
"isDefault": True,
"cidr": "0.0.0.0/0",
"description": "default",
"ipv6Cidr": "2400:da00:e003:4c00::/56",
"tags":[
{
"tagKey": "tagKey",
"tagValue": "tagValue"
}
]
}
]
} 操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_list_vpc.go
查询指定VPC
函数声明
func (c *Client) GetVPCDetail(vpcId string) (*GetVPCDetailResult, error) 参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/yjwvyuaeo
使用示例
vpcID := "vpc-p1eawhw5rx4n" // vpc id
response, err := client.GetVPCDetail(vpcID) // 获取vpc详情返回值
操作成功：
{
"vpc": {
"vpcId': "vpc-p1eawhw5rx4n",
"name": u"\u9ed8\u8ba4\u79c1\u6709\u7f51\u7edc",
"isDefault": True,
"cidr": "0.0.0.0/0",
"ipv6Cidr": "2400:da00:e003:4c00::/56",
"description": "default",
"subnets": [
{
"name": "系统预定义子网",
"subnetId": "sbn-IyWRnII7",
"zoneName": "cn-bj-a",
"cidr": "192.168.0.0/20",
"ipv6Cidr": "2400:da00:e003:4c11::/64",
"vpcId": "vpc-IyrqYIQ7",
"subnetType": "BCC",
"description": ""
"createdTime": "2018-03-14T14:45:02Z"
}
],
"tags":[
{
"tagKey": "tagKey",
"tagValue": "tagValue"
}
]
}
} 操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_get_vpc.go
删除VPC
函数声明
func (c *Client) DeleteVPC(vpcId, clientToken string) error 参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/Ijwvyua0d
使用示例
vpcID := "vpc-is0j69zp08cx"
clientToken := "be31b98c-5141-4838-9830-9be700de5a20"
err := client.DeleteVPC(vpcID, clientToken) // 删除 VPC返回值
操作成功：
{
} 操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_delete_vpc.go
更新VPC
函数声明
type UpdateVPCArgs struct {
ClientToken string `json:"-"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
}
func (c *Client) UpdateVPC(vpcId string, updateVPCArgs *UpdateVPCArgs) error参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/tjwvyubez
使用示例
clientToken := "be31b98c-5e41-4838-9830-9be700de5a20"
vpcID := "vpc-p1eawhw5rx4n"
updateVpcArgs := &vpc.UpdateVPCArgs{
ClientToken: clientToken,
Name: "test_vpc", // 更新vpc名称
Description: "", // 更新vpc描述
}
err := client.UpdateVPC(vpcID, updateVpcArgs) // 更新vpc返回值
操作成功：
{
} 操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_update_vpc.go
查询内网IP
函数声明
type GetVpcPrivateIpArgs struct {
VpcId string `json:"vpcId"`
PrivateIpAddresses []string `json:"privateIpAddresses",omitempty`
PrivateIpRange string `json:"privateIpRange,omitempty"`
}
func (c *Client) GetPrivateIpAddressesInfo(args *GetVpcPrivateIpArgs) (*VpcPrivateIpAddressesResult, error)参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/2kih0m069
使用示例
vpcID := "vpc-p1eawhw5rx4n" // vpc id
privateIPAddresses := []string{"172.17.1.1", "172.17.1.2", "172.17.1.3"} // 私有ip地址
args := &vpc.GetVpcPrivateIpArgs{
VpcId: vpcID,
PrivateIpAddresses: privateIPAddresses,
}
response, err := client.GetPrivateIpAddressesInfo(args) // 获取vpc私有ip信息返回值
操作成功：
{
{
"vpcPrivateIpAddresses": [
{
"cidr": "172.17.1.0/24",
"privateIpAddress": "172.17.1.1",
"privateIpAddressType": "sys_occupancy",
"createdTime": "2020-11-19T12:46:01Z"
},
{
"cidr": "172.17.1.0/24",
"privateIpAddress": "172.17.1.2",
"privateIpAddressType": "dhcp",
"createdTime": "2020-06-23T07:50:14Z"
},
{
"cidr": "172.17.1.0/24",
"privateIpAddress": "172.17.1.3",
"privateIpAddressType": "dhcp",
"createdTime": "2020-06-23T07:50:16Z"
}
]
}
} 操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_get_vpc_ip.go
关闭VPC中继
函数声明
type UpdateVpcRelayArgs struct {
ClientToken string `json:"-"`
VpcId string `json:"vpcId"`
}
func (c *Client) ShutdownRelay(updateVpcRelayArgs *UpdateVpcRelayArgs) error参数含义 请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/Cluccsywt
使用示例
clientToken := "ca9ab08f-55e1-4675-a55d-6939a8efe3dd"
vpcID := "vpc-p1eawhw5rx4n"
args := &vpc.UpdateVpcRelayArgs{
ClientToken: clientToken,
VpcId: vpcID,
}
err := client.ShutdownRelay(args)返回值
操作成功：
操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_shutdown_relay.go
开启VPC中继
函数声明
type UpdateVpcRelayArgs struct {
ClientToken string `json:"-"`
VpcId string `json:"vpcId"`
}
func (c *Client) OpenRelay(updateVpcRelayArgs *UpdateVpcRelayArgs) error参数含义 请参考OpenApi文档： https://cloud.baidu.com/doc/VPC/s/Lluccn0nc
使用示例
clientToken := "c587aab8-cc6d-4e36-a7a6-b78339b1469f"
vpcID := "vpc-x5re9ig1g53q"
args := &vpc.UpdateVpcRelayArgs{
ClientToken: clientToken,
VpcId: vpcID, // vpc id
}
err := client.OpenRelay(args)返回值
操作成功：
操作失败：
抛出异常，异常列表参考：https://cloud.baidu.com/doc/VPC/s/sjwvyuhe7
代码示例
具体代码示例参考： example_open_relay.go