应用型blb实例

更新时间：2023-09-11

实例管理

创建实例

通过以下代码，可以创建一个应用型LoadBalancer，返回分配的服务地址及实例ID

args := &appblb.CreateLoadBalancerArgs{
    // 设置实例名称
    Name:        "sdkBlb",
    // 设置实例描述
    Description: "sdk create",
    // 设置实例所属vpc
    VpcId:       vpcId,
    // 设置实例所属子网 
    SubnetId:    subnetId,
}

// 若要为实例设置标签，可以按照以下代码，标签设置之后，不可修改和删除
args.Tags = []model.TagModel{
    {
        TagKey:   "key", 
        TagValue: "value",
    },
}
result, err := client.CreateLoadBalancer(args)
if err != nil {
    fmt.Println("create appblb failed:", err)
} else {
    fmt.Println("create appblb success: ", result)
}

更新实例

通过以下代码，可以更新一个LoadBalancer的配置信息，如实例名称和描述

args := &appblb.UpdateLoadBalancerArgs{
    Name:        "testSdk", 
    Description: "test desc",
}
err := client.UpdateLoadBalancer(blbId, args)
if err != nil {
    fmt.Println("update appblb failed:", err)
} else {
    fmt.Println("update appblb success")
}

查询已有的实例

通过以下代码，可以查询用户账户下所有LoadBalancer的信息

args := &appblb.DescribeLoadBalancersArgs{}

// 支持按LoadBalancer的id、name、address进行查询，匹配规则支持部分包含（不支持正则）
args.BlbId = blbId
args.Name = blbName
args.Address = blbAddress
args.ExactlyMatch = true

// 支持查找绑定指定BLB的LoadBalancer，通过blbId参数指定
args.BlbId = blbId

result, err := client.DescribeLoadBalancers(args)
if err != nil {
    fmt.Println("list all appblb failed:", err)
} else {
    fmt.Println("list all appblb success: ", result)
}

查询实例详情

通过以下代码，可以按id查询用户账户下特定的应用型LoadBalancer的详细信息，包含LoadBalancer所有的监听器端口信息

result, err := client.DescribeLoadBalancerDetail(blbId)
if err != nil {
    fmt.Println("get appblb detail failed:", err)
} else {
    fmt.Println("get appblb detail success: ", result)
}

释放实例

通过以下代码，可以释放指定LoadBalancer，被释放的LoadBalancer无法找回

err := client.DeleteLoadBalancer(blbId)
if err != nil {
    fmt.Println("delete appblb failed:", err)
} else {
    fmt.Println("delete appblb success")
}

服务器组管理

创建应用型服务器组

通过以下代码，在指定应用型BLB下，创建一个服务器组，用来绑定后端服务器，以及为监听器开放相应的端口

args := &appblb.CreateAppServerGroupArgs{
    // 设置服务器组名称
    Name: "sdkTest", 
    // 设置服务器组描述
    Description: "sdk test desc",
}

// 若想直接绑定后端服务器，可以设置以下参数
args.BackendServerList = []appblb.AppBackendServer{
    {
        InstanceId: instanceId, 
        Weight:     50,
    },
}

result, err := client.CreateAppServerGroup(blbId, args)
if err != nil {
    fmt.Println("create server group failed:", err)
} else {
    fmt.Println("create server group success: ", result)
}

更新服务器组

通过以下代码，更新指定LoadBalancer下的TCP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定

args := &appblb.UpdateAppServerGroupArgs{
    // 设置要更新的服务器组ID
    SgId:        serverGroupId, 
    // 设置新的服务器组名称
    Name:        "testSdk",
    // 设置新的服务器组描述
    Description: "test desc",
}
err := client.UpdateAppServerGroup(blbId, args)
if err != nil {
    fmt.Println("update server group failed:", err)
} else {
    fmt.Println("update server group success: ", result)
}

查询服务器组

通过以下代码，查询指定LoadBalancer下所有服务器组的信息

args := &appblb.DescribeAppServerGroupArgs{}

// 按BLBID、name为条件进行全局查询
args.BlbId = blbId
args.Name = servergroupName
args.ExactlyMatch = true

result, err := client.DescribeAppServerGroup(blbId, args)
if err != nil {
    fmt.Println("describe server group failed:", err)
} else {
    fmt.Println("describe server group success: ", result)
}

删除服务器组

通过以下代码，删除服务器组，通过服务器组id指定

args := &appblb.DeleteAppServerGroupArgs{
    // 要删除的服务器组ID
    SgId: serverGroupId,
}
err := client.DeleteAppServerGroup(blbId, args)
if err != nil {
    fmt.Println("delete server group failed:", err)
} else {
    fmt.Println("delete server group success: ", result)
}

创建应用型服务器组端口

通过以下代码，在指定应用型BLB下，创建一个服务器组后端端口，将发往该端口的所有流量按权重轮询分发到其绑定的对应服务器列表中的服务器

args := &appblb.CreateAppServerGroupPortArgs{
    // 端口所属服务器组ID
    SgId: serverGroupId, 
    // 监听的端口号
    Port: 80,
    // 监听的协议类型
    Type: "TCP",
}

// 可以选择设置相应健康检查协议的参数
args.HealthCheck = "TCP"
args.HealthCheckPort = 30
args.HealthCheckIntervalInSecond = 10
args.HealthCheckTimeoutInSecond = 10

result, err := client.CreateAppServerGroupPort(blbId, args)
if err != nil {
    fmt.Println("create server group port failed:", err)
} else {
    fmt.Println("create server group port success: ", result)
}

提示：

配置健康检查协议的参数，详细请参考BLB API 文档创建应用型服务器组端口

更新服务器组端口

通过以下代码，根据id更新服务器组端口

args := &appblb.UpdateAppServerGroupPortArgs{
	// 端口所属服务器组ID
    SgId: serverGroupId, 
    // 端口Id，由创建创建应用型服务器组端口返回
    PortId: portId,
    // 设置健康检查协议参数
    HealthCheck:                 "TCP", 
    HealthCheckPort:             30,
    HealthCheckIntervalInSecond: 10, 
    HealthCheckTimeoutInSecond:  10,
}
err := client.UpdateAppServerGroupPort(blbId, args)
if err != nil {
    fmt.Println("update server group port failed:", err)
} else {
    fmt.Println("update server group port success: ", result)
}

提示：

配置健康检查协议的参数，详细请参考BLB API 文档更新服务器组端口

删除服务器组端口

通过以下代码，删除服务器组端口，通过服务器组id指定

args := &appblb.DeleteAppServerGroupPortArgs{
	// 端口所属服务器组ID
    SgId:        serverGroupId,
	// 要删除的端口服务ID列表
    PortIdList:  []string{portId}, 
}
err := client.DeleteAppServerGroupPort(blbId, args)
if err != nil {
    fmt.Println("delete server group port failed:", err)
} else {
    fmt.Println("delete server group port success: ", result)
}

添加应用型BLB后端RS

通过以下代码，在指定应用型BLB和服务器组下绑定后端服务器RS

args := &appblb.CreateBlbRsArgs{
    BlbRsWriteOpArgs: appblb.BlbRsWriteOpArgs{
        // RS所属服务器组ID
        SgId:        serverGroupId, 
        // 配置后端服务器的列表及权重
        BackendServerList: []appblb.AppBackendServer{  
            {InstanceId: instanceId, Weight: 30},
        },
    },
}
err := client.CreateBlbRs(blbId, args)
if err != nil {
    fmt.Println("create blbRs failed:", err)
} else {
    fmt.Println("create blbRs success: ", result)
}

更新服务器组下挂载的RS权重

通过以下代码，更新指定服务器组下的RS信息

args := &appblb.UpdateBlbRsArgs{
    BlbRsWriteOpArgs: appblb.BlbRsWriteOpArgs{
        // RS所属服务器组ID
        SgId:        serverGroupId, 
        // 配置要更新的后端服务器的列表及权重
        BackendServerList: []appblb.AppBackendServer{
            {InstanceId: instanceId, Weight: 60},
        },
    },
}
err := client.UpdateBlbRs(blbId, args)
if err != nil {
    fmt.Println("update blbRs failed:", err)
} else {
    fmt.Println("update blbRs success: ", result)
}

查询服务器组下的RS列表信息

通过以下代码，查询指定LoadBalancer下所有服务器组的信息

args := &appblb.DescribeBlbRsArgs{
	// RS所属服务器组ID
    SgId: serverGroupId,
}
result, err := client.DescribeBlbRs(blbId, args)
if err != nil {
    fmt.Println("describe blbRs failed:", err)
} else {
    fmt.Println("describe blbRs success: ", result)
}

删除服务器组下挂载的rs

通过以下代码，删除服务器组，通过服务器组id指定

args := &appblb.DeleteBlbRsArgs{
	// RS所属服务器组ID
    SgId: serverGroupId, 
    // 要从RS列表中删除的实例列表
    BackendServerIdList: []string{instanceId},
}
err := client.DeleteBlbRs(blbId, args)
if err != nil {
    fmt.Println("delete blbRs failed:", err)
} else {
    fmt.Println("delete blbRs success: ", result)
}

查询服务器组下绑定的server

通过以下代码，查询服务器组下绑定的server

result, err := client.DescribeRsMount(blbId, serverGroupId)
if err != nil {
    fmt.Println("describe mount Rs list failed:", err)
} else {
    fmt.Println("describe mount Rs list success: ", result)
}

查询服务器组下未绑定的RS

通过以下代码，查询服务器组下未绑定的RS

result, err := client.DescribeRsUnMount(blbId, serverGroupId)
if err != nil {
    fmt.Println("describe unmount Rs list failed:", err)
} else {
    fmt.Println("describe unmount Rs list success: ", result)
}

监听器管理

创建TCP监听器

通过以下代码，在指定LoadBalancer下，创建一个基于TCP协议的应用型blb监听器，监听一个前端端口，将发往该端口的所有TCP流量，根据策略进行转发

args := &appblb.CreateAppTCPListenerArgs{
    // 监听器监听的端口，需要在1-65535之间
    ListenerPort: 90,
    // 负载均衡算法，支持RoundRobin/LeastConnection/Hash
    Scheduler: "RoundRobin",
    // TCP设置链接超时时间，默认900秒，需要为10-4000之间的整数
    TcpSessionTimeout: 1000,
}
err := client.CreateAppTCPListener(BLBID, args)
if err != nil {
    fmt.Println("create TCP Listener failed:", err)
} else {
    fmt.Println("create TCP Listener success")
}

更新TCP监听器

通过以下代码，更新指定LoadBalancer下的TCP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定

args := &appblb.UpdateAppTCPListenerArgs{
    UpdateAppListenerArgs: appblb.UpdateAppListenerArgs{
        // 要更新的监听器端口号
        ListenerPort: 90, 
        // 更新负载均衡的算法
        Scheduler:    "Hash", 
        // 更新tcp链接超时时间
        TcpSessionTimeout: 2000,
    },
}
err := client.UpdateAppTCPListener(BLBID, args)
if err != nil {
    fmt.Println("update TCP Listener failed:", err)
} else {
    fmt.Println("update TCP Listener success")
}

查询TCP监听器

通过以下代码，查询指定LoadBalancer下所有TCP监听器的信息，支持按监听器端口进行匹配查询，结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

args := &appblb.DescribeAppListenerArgs{
    // 要查询的监听器端口
    ListenerPort: 90,
}
result, err := client.DescribeAppTCPListeners(BLBID, args)
if err != nil {
    fmt.Println("describe TCP Listener failed:", err)
} else {
    fmt.Println("describe TCP Listener success: ", result)
}

创建UDP监听器

通过以下代码，在指定LoadBalancer下，创建一个基于UDP协议的应用型监听器，监听一个前端端口，将发往该端口的所有UDP流量，根据策略进行转发

args := &appblb.CreateAppUDPListenerArgs{
    // 监听器监听的端口，需要在1-65535之间
    ListenerPort: 80,
    // 负载均衡算法，支持RoundRobin/LeastConnection/Hash
    Scheduler:    "RoundRobin",
}
err := client.CreateAppUDPListener(BLBID, args)
if err != nil {
    fmt.Println("create UDP Listener failed:", err)
} else {
    fmt.Println("create UDP Listener success")
}

更新UDP监听器

通过以下代码，更新指定LoadBalancer下的UDP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定

args := &appblb.UpdateAppUDPListenerArgs{
    UpdateAppListenerArgs: appblb.UpdateAppListenerArgs{
        // 要更新的监听器端口号
        ListenerPort: 80, 
        // 更新负载均衡的算法
        Scheduler:    "Hash",
    },
}
err := client.UpdateAppUDPListener(BLBID, args)
if err != nil {
    fmt.Println("update UDP Listener failed:", err)
} else {
    fmt.Println("update UDP Listener success")
}

查询UDP监听器

通过以下代码，查询指定LoadBalancer下所有UDP监听器的信息，支持按监听器端口进行匹配查询，结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

args := &appblb.DescribeAppListenerArgs{
    // 要查询的监听器端口
    ListenerPort: 80,
}
result, err := client.DescribeAppUDPListeners(BLBID, args)
if err != nil {
    fmt.Println("describe UDP Listener failed:", err)
} else {
    fmt.Println("describe UDP Listener success: ", result)
}

创建HTTP监听器

通过以下代码，在指定LoadBalancer下，创建一个基于HTTP协议的应用型监听器，监听一个前端端口，将发往该端口的所有HTTP请求，根据策略转发到后端服务器监听的后端端口上

args := &appblb.CreateAppHTTPListenerArgs{
    // 监听器监听的端口，需要在1-65535之间
    ListenerPort: 80,
    // 负载均衡算法，支持RoundRobin/LeastConnection
    Scheduler:    "RoundRobin",
}
err := client.CreateAppHTTPListener(BLBID, args)
if err != nil {
    fmt.Println("create HTTP Listener failed:", err)
} else {
    fmt.Println("create HTTP Listener success")
}

提示：

详细的参数配置及限制条件，可以参考BLB API 文档创建HTTP监听器

更新HTTP监听器

通过以下代码，更新指定LoadBalancer下的HTTP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定

args := &appblb.UpdateAppHTTPListenerArgs{
	// 要更新的监听器端口号
    ListenerPort: 80,
    // 更新负载均衡的算法
    Scheduler:    "LeastConnection", 
    // 开启会话保持功能
    KeepSession:  true,
}
err := client.UpdateAppHTTPListener(BLBID, args)
if err != nil {
    fmt.Println("update HTTP Listener failed:", err)
} else {
    fmt.Println("update HTTP Listener success")
}

提示：

详细的参数配置及限制条件，可以参考BLB API 文档更新HTTP监听器

查询HTTP监听器

通过以下代码，查询指定LoadBalancer下所有HTTP监听器的信息，支持按监听器端口进行匹配查询，结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

args := &appblb.DescribeAppListenerArgs{
    // 要查询的监听器端口
    ListenerPort: 80,
}
result, err := client.DescribeAppHTTPListeners(BLBID, args)
if err != nil {
    fmt.Println("describe HTTP Listener failed:", err)
} else {
    fmt.Println("describe HTTP Listener success: ", result)
}

创建HTTPS监听器

通过以下代码，在指定LoadBalancer下，创建一个基于HTTPS协议的应用型监听器，监听一个前端端口，将发往该端口的所有HTTPS请求，先通过SSL卸载转换为HTTP请求后，再根据策略转发到后端服务器监听的后端端口上

args := &appblb.CreateAppHTTPSListenerArgs{
    // 监听器监听的端口，需要在1-65535之间
    ListenerPort: 80,
    // 负载均衡算法，支持RoundRobin/LeastConnection
    Scheduler:    "RoundRobin", 
    // 配置证书列表
    CertIds:      []string{certId},
}
err := client.CreateAppHTTPSListener(BLBID, args)
if err != nil {
    fmt.Println("create HTTPS Listener failed:", err)
} else {
    fmt.Println("create HTTPS Listener success")
}

提示：

详细的参数配置及限制条件，可以参考BLB API 文档创建HTTPS监听器

更新HTTPS监听器

通过以下代码，更新指定LoadBalancer下的HTTPS监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定

args := &appblb.UpdateAppHTTPSListenerArgs{
	// 要更新的监听器端口号
    ListenerPort: 80,
    // 更新负载均衡的算法
    Scheduler:    "LeastConnection", 
    // 开启会话保持功能
    KeepSession:  true,
    // 配置证书列表
    CertIds:      []string{certId},
}
err := client.UpdateAppHTTPSListener(BLBID, args)
if err != nil {
    fmt.Println("update HTTPS Listener failed:", err)
} else {
    fmt.Println("update HTTPS Listener success")
}

提示：

详细的参数配置及限制条件，可以参考BLB API 文档更新HTTPS监听器

查询HTTPS监听器

通过以下代码，查询指定LoadBalancer下所有HTTPS监听器的信息，支持按监听器端口进行匹配查询，结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

args := &appblb.DescribeAppListenerArgs{
    // 要查询的监听器端口
    ListenerPort: 80,
}
result, err := client.DescribeAppHTTPSListeners(BLBID, args)
if err != nil {
    fmt.Println("describe HTTPS Listener failed:", err)
} else {
    fmt.Println("describe HTTPS Listener success: ", result)
}

创建SSL监听器

通过以下代码，在指定LoadBalancer下，创建一个基于SSL协议的应用型blb监听器，监听一个前端端口，将发往该端口的所有SSL流量，根据策略进行转发

args := &appblb.CreateAppSSLListenerArgs{
    // 监听器监听的端口，需要在1-65535之间
    ListenerPort: 80,
    // 负载均衡算法，支持RoundRobin/LeastConnection/Hash
    Scheduler:    "RoundRobin", 
    // 配置证书列表
    CertIds:      []string{certId},
}
err := client.CreateAppSSLListener(BLBID, args)
if err != nil {
    fmt.Println("create SSL Listener failed:", err)
} else {
    fmt.Println("create SSL Listener success")
}

提示：

详细的参数配置及限制条件，可以参考BLB API 文档创建SSL监听器

更新SSL监听器

通过以下代码，更新指定LoadBalancer下的SSL监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定

args := &appblb.UpdateAppSSLListenerArgs{
	// 要更新的监听器端口号
    ListenerPort: 80,
    // 更新负载均衡的算法
    Scheduler:    "LeastConnection", 
    // 配置证书列表
    CertIds:      []string{certId},
}
err := client.UpdateAppSSLListener(BLBID, args)
if err != nil {
    fmt.Println("update SSL Listener failed:", err)
} else {
    fmt.Println("update SSL Listener success")
}

提示：

详细的参数配置及限制条件，可以参考BLB API 文档更新SSL监听器

查询SSL监听器

args := &appblb.DescribeAppListenerArgs{
    // 要查询的监听器端口
    ListenerPort: 80,
}
result, err := client.DescribeAppSSLListeners(BLBID, args)
if err != nil {
    fmt.Println("describe SSL Listener failed:", err)
} else {
    fmt.Println("describe SSL Listener success: ", result)
}

删除监听器

通过以下代码，释放指定LoadBalancer下的监听器，监听器通过监听端口来指定，支持批量释放

args := &appblb.DeleteAppListenersArgs{
    // 要删除的监听器监听的端口
    PortList:    []uint16{80}, 
}
err := client.DeleteAppListeners(BLBID, args)
if err != nil {
    fmt.Println("delete Listeners failed:", err)
} else {
    fmt.Println("delete Listeners success: ", result)
}

创建策略

通过以下代码，在指定应用型BLB监听器端口下创建策略

args := &appblb.CreatePolicysArgs{
    // 需要绑定策略的监听器监听的端口
    ListenerPort: 80,
    // 需要绑定的策略，其中TCP/UDP/SSL仅支持绑定一个策略，HTTP/HTTPS支持绑定多个策略 
    AppPolicyVos: []appblb.AppPolicy{
    {
        // 策略描述
        Description:      "test policy", 
        // 策略绑定的服务器组ID
        AppServerGroupId: servergroupId, 
        // 目标端口号
        BackendPort:      80, 
        // 策略的优先级，有效取值范围为1-32768
        Priority:         301, 
        // 策略的规则列表，TCP/UDP/SSL仅支持{*：*}策略
        RuleList: []appblb.AppRule{
                {
                    Key:   "*",
                    Value: "*",	
                },
            },
        },
    },
}
err := client.CreatePolicys(blbId, args)
if err != nil {
    fmt.Println("create policy failed:", err)
} else {
    fmt.Println("create policy success")
}

提示：

策略中backendPort参数，即目标端口号，当listenerPort对应监听器为TCP或SSL时需要传入对应服务器组（appServerGroupId）下开放的TCP端口号；当listenerPort对应监听器为HTTP或HTTPS时需要传入对应服务器组（appServerGroupId）下开放的HTTP端口号；当listenerPort对应监听器为UDP时需要传入对应服务器组（appServerGroupId）下开放的UDP端口号

各个协议可绑定的策略的具体配置参数，可以参考BLB API 文档创建策略

查询对应BLB端口下策略信息

通过以下代码，查询指定LoadBalancer下所有服务器组的信息，支持按监听器端口进行匹配查询，结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

args := &appblb.DescribePolicysArgs{
    // 要查询的监听器端口号
    Port: 80,
}
result, err := client.DescribePolicys(blbId, args)
if err != nil {
    fmt.Println("describe policy failed:", err)
} else {
    fmt.Println("describe policy success: ", result)
}

批量删除策略

通过以下代码，批量删除对应BLB端口下的策略

args := &appblb.DeletePolicysArgs{
    // 要删除策略所在监听器的端口号
    Port: 80, 
    // 要删除的策略ID列表
    PolicyIdList: []string{describeResult.PolicyList[0].Id}, 
}
err := client.DeletePolicys(blbId, args)
if err != nil {
    fmt.Println("delete policy failed:", err)
} else {
    fmt.Println("delete policy success")
}

错误处理

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

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

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

// blbClient 为已创建的BLB Client对象
blbDetail, err := blbClient.DescribeLoadBalancerDetail(blbId)
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)
	}
} else {
	fmt.Println("get appblb detail success: ", blbDetail)
}

普通型blb实例

版本变更记录

负载均衡 BLB