应用型blb实例

更新时间：2024-01-24

应用型blb实例针对用户复杂应用部署架构，特别是大型网站架构。使用基于策略的网络管理框架构建，实现业务驱动的流量负载均衡。

self即app_blb_client；具体各个参数含义请参考blb官方文档，api参考下的应用型blb接口

创建应用型blb实例

创建一个LoadBalancer，返回分配的服务地址及实例ID。付费方式为后付费。需要实名认证，若未通过实名认证可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。

使用以下代码可以创建应用型blb实例：

函数声明

Plain Text

1def create_app_loadbalancer(self, vpc_id, subnet_id, name=None, desc=None, client_token=None, config=None)

参数含义

请参考OpenAPI文档：CreateLoadBalancer创建实例

返回值

操作成功：

Plain Text

1{
2  blb_id:'lb-1a22b118',
3  name:'BLB-beijing-a60ce0c4',
4  desc:'',
5  address:'192.168.0.7'
6}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_loadbalancer.py

更新应用型blb实例

更新一个LoadBalancer的配置信息。

使用以下代码可以更新应用型blb实例：

函数声明

Plain Text

1  def update_app_loadbalancer(self, blb_id, name=None, desc=None, client_token=None, config=None)

参数含义

请参考OpenAPI文档：UpdateLoadBalancer更新实例

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_loadbalancer.py

查询应用型blb实例列表

查询用户账户下所有LoadBalancer的信息。支持按LoadBalancer的id、name、address进行查询，匹配规则支持部分包含（不支持正则）。支持查找绑定指定BCC的LoadBalancer，通过bccId参数指定。返回结果是多重查询条件的交集。结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

使用以下代码可以查询应用型blb实例列表：

函数声明

Plain Text

1def describe_app_loadbalancers(self, address=None, name=None, blb_id=None, bcc_id=None, marker=None, max_keys=None, config=None)

参数含义

请参考OpenAPI文档：DescribeLoadBalancers查询已有的BLB实例

返回值

操作成功：

Plain Text

1{
2  blb_list:[{
3    tags:None,
4    blb_id:'lb-cf2dc4e7',
5    status:'available',
6    name:'testappblb',
7    desc:'appjustForTest',
8    address:'192.168.0.4',
9    vpc_id:'vpc-sr84haq14tcb',
10    subnet_id:'sbn-kg7mj5wt4yw9',
11    allow_delete:True,
12    payment_timing:'Postpaid'}, 
13  ]
14  marker:'blb-05FA0CED',
15  next_marker:None,
16  is_truncated:False,
17  max_keys:1000
18 }

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_loadbalancers.py

查询应用型blb实例详情

按id查询用户账户下所有LoadBalancer的详细信息。包含LoadBalancer所有的监听器端口信息

使用以下代码可以查询应用型blb实例详情：

函数声明

Plain Text

1def describe_app_loadbalancer_detail(self, blb_id, config=None)

参数含义

请参考OpenAPI文档：DescribeLoadBalancerDetail查询BLB实例详情

返回值

操作成功：

Plain Text

1{
2  tags:None,
3  blb_id:'lb-cf2dc4e7',
4  status:'available',
5  name:'testappblb',
6  desc:'appjustForTest',
7  address:'192.168.0.4',
8  cidr:'192.168.0.0/16',
9  vpc_name:'test',
10  subnet_name:'test',
11  subnet_cider:'192.168.0.0/24',
12  create_time:'2023-12-11T14:14:36Z',
13  ipv6:'',
14  allow_delete:True,
15  listener:[],
16  support_acl:True,
17  payment_timing:'Postpaid',
18  vpc_id:'vpc-sr84haq14tcb'
19 }

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_loadbalancer_detail.py

删除应用型blb实例

释放指定LoadBalancer，被释放的LoadBalancer无法找回

使用以下代码可以删除应用型blb实例：

函数声明

Plain Text

1def delete_app_loadbalancer(self, blb_id, client_token=None, config=None)

参数含义

请参考OpenAPI文档：DeleteLoadBalancer释放BLB实例

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_app_loadbalancer.py

创建TCP监听器

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

使用以下代码可以创建TCP监听器

函数声明

Plain Text

1    def create_app_tcp_listener(self, blb_id, listener_port,
2                                scheduler, client_token=None,
3                                config=None)

参数含义

请参考OpenAPI文档：CreateAppTCPListener创建TCP监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_tcp_listener.py

创建UDP监听器

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

使用以下代码可以创建UDP监听器

函数声明

Plain Text

1    def create_app_udp_listener(self, blb_id, listener_port,
2                                scheduler, client_token=None,
3                                config=None)

参数含义

请参考OpenAPI文档：CreateAppUDPListener创建UDP监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_udp_listener.py

创建HTTP监听器

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

使用以下代码可以创建HTTP监听器

函数声明

Plain Text

1    def create_app_http_listener(self, blb_id, listener_port,
2                                 scheduler, keep_session=None,
3                                 keep_session_type=None,
4                                 keep_session_timeout=None,
5                                 keep_session_cookie_name=None,
6                                 x_forwarded_for=None,
7                                 server_timeout=None,
8                                 redirect_port=None,
9                                 client_token=None,
10                                 config=None)

参数含义

请参考OpenAPI文档：CreateAppHTTPListener创建HTTP监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_http_listener.py

创建HTTPS监听器

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

使用以下代码可以创建HTTPS监听器

函数声明

Plain Text

1    def create_app_https_listener(self, blb_id, listener_port,
2                                  scheduler, cert_ids,
3                                  keep_session=None,
4                                  keep_session_type=None,
5                                  keep_session_timeout=None,
6                                  keep_session_cookie_name=None,
7                                  x_forwarded_for=None, server_timeout=None,
8                                  ie6_compatible=None, encryption_type=None,
9                                  encryption_protocols=None,
10                                  dual_auth=None, client_certIds=None,
11                                  client_token=None, config=None)

参数含义

请参考OpenAPI文档：CreateAppHTTPSListener创建HTTPS监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_https_listener.py

创建SSL监听器

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

使用以下代码可以创建SSL监听器

函数声明

Plain Text

1    def create_app_ssl_listener(self, blb_id, listener_port,
2                                scheduler, cert_ids,
3                                ie6_compatible=None,
4                                encryption_type=None,
5                                encryption_protocols=None,
6                                dual_auth=None, client_certIds=None,
7                                client_token=None, config=None)

参数含义

请参考OpenAPI文档：CreateAppSSLListener创建SSL监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_ssl_listener.py

更新TCP监听器

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

使用以下代码可以更新TCP监听器

函数声明

Plain Text

1    def update_app_tcp_listener(self, blb_id, listener_port,
2                                scheduler=None,
3                                client_token=None,
4                                config=None)

参数含义

请参考OpenAPI文档：UpdateAppTCPListener更新TCP监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_tcp_listener.py

更新UDP监听器

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

使用以下代码可以更新UDP监听器

函数声明

Plain Text

1    def update_app_udp_listener(self, blb_id, listener_port,
2                                scheduler=None, client_token=None,
3                                config=None)

参数含义

请参考OpenAPI文档：UpdateAppUDPListener更新UDP监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_udp_listener.py

更新HTTP监听器

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

使用以下代码可以更新HTTP监听器

函数声明

Plain Text

1    def update_app_http_listener(self, blb_id, listener_port,
2                                 scheduler=None, keep_session=None,
3                                 keep_session_type=None,
4                                 keep_session_timeout=None,
5                                 keep_session_cookie_name=None,
6                                 x_forwarded_for=None,
7                                 server_timeout=None,
8                                 redirect_port=None,
9                                 client_token=None,
10                                 config=None)

参数含义

请参考OpenAPI文档：UpdateAppHTTPListener更新HTTP监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_http_listener.py

更新HTTPS监听器

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

使用以下代码可以更新HTTPS监听器

函数声明

Plain Text

1def update_app_https_listener(self, blb_id, listener_port,
2                              scheduler=None,
3                              keep_session=None,
4                              keep_session_type=None,
5                              keep_session_timeout=None,
6                              keep_session_cookie_name=None,
7                              x_forwarded_for=None,
8                              server_timeout=None,
9                              cert_ids=None,
10                              ie6_compatible=None,
11                              encryption_type=None,
12                              encryption_protocols=None,
13                              dual_auth=None,
14                              client_certIds=None,
15                              client_token=None,
16                              config=None)

参数含义

请参考OpenAPI文档：UpdateAppHTTPSListener更新HTTPS监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_https_listener.py

更新应用型SSL监听器

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

使用以下代码可以更新应用型SSL监听器

函数声明

Plain Text

1    def update_app_ssl_listener(self, blb_id, listener_port,
2                                scheduler=None,
3                                cert_ids=None,
4                                ie6_compatible=None,
5                                encryption_type=None,
6                                encryption_protocols=None,
7                                dual_auth=None,
8                                client_certIds=None,
9                                client_token=None,
10                                config=None)

参数含义

请参考OpenAPI文档：UpdateAppSSLListener更新应用型SSL监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_ssl_listener.py

查询应用型TCP监听器

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

使用以下代码可以查询应用型TCP监听器

函数声明

Plain Text

1    def describe_app_tcp_listener(self, blb_id, listener_port=None,
2                                  marker=None, max_keys=None,
3                                  config=None)

参数含义

请参考OpenAPI文档：DescribeAppTCPListeners查询应用型TCP监听器

返回值

操作成功：

Plain Text

1{
2    "listenerList": [
3        {
4            "listenerPort": 80,
5            "scheduler": "RoundRobin"
6        },
7        {
8            "listenerPort": 88,
9            "scheduler": "RoundRobin"
10        }
11    ],
12    "marker": "listener-0050",
13    "nextMarker": null,
14    "isTruncated": false,
15    "maxKeys": 2
16}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_tcp_listener.py

查询UDP监听器

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

使用以下代码可以查询UDP监听器

函数声明

Plain Text

1    def describe_app_udp_listener(self, blb_id, listener_port=None,
2                                  marker=None, max_keys=None,
3                                  config=None)

参数含义

请参考OpenAPI文档：DescribeAppUDPListeners查询UDP监听器

返回值

操作成功：

Plain Text

1{
2    "listenerList": [
3        {
4            "listenerPort": 80,
5            "scheduler": "RoundRobin",
6            "udpSessionTimeout":90
7        },
8        {
9            "listenerPort": 88,
10            "scheduler": "RoundRobin",
11            "udpSessionTimeout":90
12        }
13    ],
14    "marker": "listener-0050",
15    "nextMarker": null,
16    "isTruncated": false,
17    "maxKeys": 2
18}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_udp_listener.py

查询HTTP监听器

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

使用以下代码可以查询HTTP监听器

函数声明

Plain Text

1    def describe_app_http_listener(self, blb_id, listener_port=None,
2                                   marker=None, max_keys=None,
3                                   config=None)

参数含义

请参考OpenAPI文档：DescribeAppHTTPListeners查询HTTP监听器

返回值

操作成功：

Plain Text

1{
2    "listenerList": [
3        {
4            "listenerPort": 90,
5            "backendPort": 90,
6            "scheduler": "LeastConnection",
7            "keepSession": false,
8            "keepSessionType": null,
9            "keepSessionTimeout": null,
10            "keepSessionCookieName": null,
11            "xForwardedFor": false,
12            "serverTimeout": 30,
13            "redirectPort": 80
14        },
15        {
16            "listenerPort": 95,
17            "backendPort": 95,
18            "scheduler": "LeastConnection",
19            "keepSession": false,
20            "keepSessionType": null,
21            "keepSessionTimeout": null,
22            "keepSessionCookieName": null,
23            "xForwardedFor": false,
24            "serverTimeout": 1800,
25            "redirectPort": 80
26        }
27    ],
28    "marker": "listener-005A",
29    "nextMarker": null,
30    "isTruncated": false,
31    "maxKeys": 2
32}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_http_listener.py

查询HTTPS监听器

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

使用以下代码可以查询HTTPS监听器

函数声明

Plain Text

1    def describe_app_https_listener(self, blb_id, listener_port=None,
2                                    marker=None, max_keys=None,
3                                    config=None)

参数含义

请参考OpenAPI文档：DescribeAppHTTPSListeners查询HTTPS监听器

返回值

操作成功：

Plain Text

1{
2    "listenerList": [
3        {
4            "listenerPort": 90,
5            "backendPort": 90,
6            "scheduler": "LeastConnection",
7            "keepSession": false,
8            "keepSessionType": null,
9            "keepSessionTimeout": null,
10            "keepSessionCookieName": null,
11            "xForwardedFor": false,
12            "serverTimeout": 30,
13            "certIds": ["cert-zfj2ey2z4kmm"]
14        },
15        {
16            "listenerPort": 95,
17            "backendPort": 95,
18            "scheduler": "LeastConnection",
19            "keepSession": false,
20            "keepSessionType": null,
21            "keepSessionTimeout": null,
22            "keepSessionCookieName": null,
23            "xForwardedFor": false,
24            "serverTimeout": 1800,
25            "certIds": ["cert-zfj2ey2z4kmm"]
26        }
27    ],
28    "marker": "listener-005A",
29    "nextMarker": null,
30    "isTruncated": false,
31    "maxKeys": 2
32}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_https_listener.py

查询应用型SSL监听器

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

使用以下代码可以查询应用型SSL监听器

函数声明

Plain Text

1    def describe_app_ssl_listener(self, blb_id, listener_port=None,
2                              marker=None, max_keys=None, config=None)

参数含义

请参考OpenAPI文档：DescribeAppSSLListeners查询应用型SSL监听器

返回值

操作成功：

Plain Text

1{
2    "listenerList": [
3        {
4            "listenerPort": 80,
5            "scheduler": "RoundRobin",
6            "certIds": ["cert-zfj2ey2z4kmm"]
7        },
8        {
9            "listenerPort": 88,
10            "scheduler": "RoundRobin",
11            "certIds": ["cert-zfj2ey2z4kmm"]
12        }
13    ],
14    "marker": "listener-0050",
15    "nextMarker": null,
16    "isTruncated": false,
17    "maxKeys": 2
18}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_ssl_listener.py

查询所有监听

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

使用以下代码可以查询所有监听

函数声明

Plain Text

1    def describe_app_all_listener(self, blb_id, listener_port=None,
2                              marker=None, max_keys=None, config=None)

参数含义

请参考OpenAPI文档：DescribeAppAllListeners查询所有监听

返回值

操作成功：

Plain Text

1{
2    "nextMarker": "",
3    "marker": "",
4    "maxKeys": 1,
5    "isTruncated": true,
6    "listenerList": [
7        {
8        "listenerPort": 53,
9        "scheduler": "RoundRobin",
10        "listenerType": "UDP"
11    },
12    {
13        "listenerPort": 80,
14        "scheduler": "RoundRobin",
15        "listenerType": "HTTP",
16        "keepSession": false,
17        "xForwardFor": true,
18        "xForwardedProto": false,
19        "serverTimeout": 30,
20        "redirectPort": 0
21    },
22    {
23        "listenerPort": 81,
24        "scheduler": "RoundRobin",
25        "listenerType": "TCP",
26        "tcpSessionTimeout": 900
27    },
28    {
29        "listenerPort": 443,
30        "scheduler": "RoundRobin",
31        "listenerType": "SSL",
32        "certIds": [
33            "cert-gs8bktrm7drp"
34        ],
35        "dualAuth": false,
36        "encryptionType": "tls_cipher_policy_ie",
37        "encryptionProtocols": [
38            "sslv3",
39            "tlsv10",
40            "tlsv11",
41            "tlsv12"
42        ],
43        "appliedCiphers": "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-ECDSA-RC4-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-RSA-RC4-SHA:ECDHE-RSA-DES-CBC3-SHA:RC4-SHA:AES128-GCM-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:AES128-SHA256:DES-CBC3-SHA"
44    },
45    {
46        "listenerPort": 444,
47        "scheduler": "RoundRobin",
48        "listenerType": "HTTPS",
49        "keepSession": false,
50        "xForwardFor": false,
51        "xForwardedProto": false,
52        "serverTimeout": 30,
53        "certIds": [
54            "cert-gs8bktrm7drp"
55        ],
56        "dualAuth": false,
57        "encryptionType": "tls_cipher_policy_1_1",
58        "encryptionProtocols": [
59            "tlsv11",
60            "tlsv12"
61        ],
62        "appliedCiphers": "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:AES256-SHA:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES128-SHA256:DES-CBC3-SHA"
63    }
64    ]
65}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_all_listener.py

释放监听器

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

使用以下代码可以释放监听器

函数声明

Plain Text

1    def delete_app_listeners(self, blb_id, portList,
2                             client_token=None,
3                             config=None)

参数含义

请参考OpenAPI文档：DeleteAppListeners释放监听器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_app_listener.py

创建策略

在指定应用型BLB监听器端口下创建策略。

使用以下代码可以创建策略

函数声明

Plain Text

1    def create_policys(self, blb_id, listener_port,
2                       app_policy_vos, client_token=None,
3                       config=None)

参数含义

请参考OpenAPI文档：CreatePolicys创建策略

返回值

操作成功：

Plain Text

1{
2    "listenerPort": 98,
3    "type": "HTTP",
4    "appPolicyVos": [
5        {
6            "appServerGroupId": "sg-db3975dc",
7            "backendPort": 83,
8            "priority": 100,
9            "desc": "aa",
10            "ruleList": [
11                {
12                    "key": "*",
13                    "value": "*"
14                }
15            ]
16        }
17    ]
18}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_policys.py

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

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

使用以下代码可以查询对应BLB端口下策略信息

函数声明

Plain Text

1    def describe_policys(self, blb_id, listener_port,
2                         marker=None, max_keys=None,
3                         config=None)

参数含义

请参考OpenAPI文档：DescribePolicys查询对应BLB端口下策略信息

返回值

操作成功：

Plain Text

1{
2    "marker": "rs-012310",          
3    "isTruncated": true,
4    "maxKeys": 1000,
5    "nextMarker": "rs-013214",      
6    "policyList":[
7        {
8            "id":"policy_id",
9            "appServerGroupId":”sg_id“,
10            "appServerGroupName":”sg_name“,
11            "frontendPort":80,
12            "type":"TCP",
13            "backendPort":98,
14            "portType":"TCP",
15            "priority":100,
16            "desc":"aa",
17            "groupType":"Server",
18            "ruleList": [
19                {
20                    "key": "host",
21                    "value": "*.baidu.com"
22                }
23            ]
24        }
25    ] 
26}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_policys.py

批量删除策略

批量删除对应BLB端口下的策略。

使用以下代码可以批量删除策略

函数声明

Plain Text

1    def delete_policys(self, blb_id, listener_port,
2                         policys_list,
3                         client_token=None, config=None)

参数含义

请参考OpenAPI文档：DeletePolicys批量删除策略

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_policys.py

创建应用型blb服务器组

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

使用以下代码可以创建应用型blb服务器组

函数声明

Plain Text

1def create_app_server_group(self, blb_id,
2                            name=None,
3                            desc=None,
4                            backend_server_list=None,
5                            client_token=None,
6                            config=None)

参数含义

请参考OpenAPI文档：CreateaAppServerGroup创建应用型服务器组

返回值

操作成功：

Plain Text

1{
2    "status":"available",
3    "name":"exmaple",
4    "id":"sg-b71fc32a",
5    "desc":"example"
6}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_server_group.py

更新应用型blb服务器组

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

使用以下代码可以更新应用型blb服务器组

函数声明

Plain Text

1def update_app_server_group(self, blb_id, sg_id,
2                            name=None,
3                            desc=None,
4                            client_token=None,
5                            config=None)

参数含义

请参考OpenAPI文档：UpdateAppServerGroup更新服务器组

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_server_group.py

查询应用型blb服务器组

查询指定LoadBalancer下所有服务器组的信息，结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定。

使用以下代码可以查询应用型blb服务器组

函数声明

Plain Text

1def describe_app_server_group(self, blb_id,
2                              name=None,
3                              exactly_match=None,
4                              marker=None,
5                              max_keys=None, config=None)

参数含义

请参考OpenAPI文档：DescribeAppServerGroup查询服务器组

返回值

操作成功：

Plain Text

1{
2    "max_keys":1000,
3    "next_marker":None,
4    "app_server_group_list":[
5        {
6            "status":"available",
7            "desc":"example2",
8            "id":"sg-0a950a17",
9            "name":"exmaple2",
10            "port_list":[
11
12            ]
13        }
14    ],
15    "marker":"60742",
16    "is_truncated":false
17}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_server_group.py

删除应用型blb服务器组

删除服务器组，通过服务器组id指定。

使用以下代码可以删除应用型blb服务器组

函数声明

Plain Text

1def delete_app_server_group(self, blb_id, sg_id,
2                            client_token=None,
3                            config=None)

参数含义

请参考OpenAPI文档：DeleteAppServerGroup删除服务器组

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_app_server_group.py

创建应用型blb服务器组端口

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

使用以下代码可以创建应用型blb服务器组端口

函数声明

Plain Text

1def create_app_server_group_port(self, blb_id, sg_id,
2                                 port, protocol_type,
3                                 health_check=None,
4                                 health_check_port=None,
5                                 health_check_urlpath=None,
6                                 health_check_timeout_insecond=None,
7                                 health_check_interval_insecond=None,
8                                 health_check_down_retry=None,
9                                 health_check_up_retry=None,
10                                 health_check_normal_status=None,
11                                 udp_health_check_string=None,
12                                 client_token=None,
13                                 config=None)

参数含义

请参考OpenAPI文档：CreateAppServerGroupPort创建应用型服务器组端口

返回值

操作成功：

Plain Text

1{
2    "status":"available",
3    "id":"port-ba811b4f"
4}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_server_group_port.py

更新应用型blb服务器组端口

根据id更新服务器组端口。

使用以下代码可以更新应用型blb服务器组端口

函数声明

Plain Text

1def update_app_server_group_port(self, blb_id, sg_id, port_id,
2                                 health_check=None,
3                                 health_check_port=None,
4                                 health_check_urlpath=None,
5                                 health_check_timeout_insecond=None,
6                                 health_check_interval_insecond=None,
7                                 health_check_down_retry=None,
8                                 health_check_up_retry=None,
9                                 health_check_normal_status=None,
10                                 udp_health_check_string=None,
11                                 client_token=None,
12                                 config=None)

参数含义

请参考OpenAPI文档：UpdateAppServerGroupPort更新服务器组端口

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_server_group_port.py

删除应用型blb服务器组端口

删除服务器组端口，通过服务器组id指定。

使用以下代码可以删除应用型blb服务器组端口

函数声明

Plain Text

1def delete_app_server_group_port(self, blb_id, sg_id,
2                                 port_list,
3                                 client_token=None, config=None)

参数含义

请参考OpenAPI文档：DeleteAppServerGroupPort删除服务器组端口

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_app_server_group_port.py

添加应用型blb后端服务器

在指定应用型BLB和服务器组下绑定后端服务器RS。

使用以下代码可以添加应用型blb后端服务器

函数声明

Plain Text

1    def create_app_blb_rs(self, blb_id, sg_id,
2                          backend_server_list,
3                          client_token=None,
4                          config=None)

参数含义

请参考OpenAPI文档：添加应用型BLB后端RS

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_create_app_blb_rs.py

更新应用型blb后端服务器

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

使用以下代码可以更新应用型blb后端服务器

函数声明

Plain Text

1    def update_app_blb_rs(self, blb_id, sg_id,
2                          backend_server_list,
3                          client_token=None,
4                          config=None)

参数含义

请参考OpenAPI文档：更新服务器组下挂载的RS权重

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_update_app_blb_rs.py

删除应用型blb后端服务器

删除服务器组，通过服务器组id指定。

使用以下代码可以删除应用型blb后端服务器

函数声明

Plain Text

1    def delete_app_blb_rs(self, blb_id, sg_id,
2                          backend_server_list,
3                          client_token=None,
4                          config=None)

参数含义

请参考OpenAPI文档：删除应用型blb的后端服务器

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_delete_app_blb_rs.py

查询服务器组下的RS信息

查询指定LoadBalancer下的指定服务器组下的RS信息

使用以下代码可以查询服务器组下的RS信息

函数声明

Plain Text

1    def describe_app_blb_rs(self, blb_id, sg_id,
2                            marker=None, max_keys=None,
3                            config=None)

参数含义

请参考OpenAPI文档：查询服务器组下的RS列表信息

返回值

操作成功：

Plain Text

1{
2    "marker": "rs-012310",          
3    "isTruncated": false,
4    "maxKeys": 1000,
5    "nextMarker": "rs-013214",      
6    "backendServerList": [
7    {
8        "instanceId": "BCC_UUID",
9        "privateIp": "192.168.0.1",              
10        "weight": "WEIGHT",
11        "portList": [                            
12        {
13            "listenerPort": "LISTENER_PORT1",
14            "backendPort": "BACKEND_PORT1",
15            "portType": "HTTP",
16            “healthCheckPortType”： "HTTP",
17            "portId": "port_xxx",             
18            "policyId": "policy_xxx",             
19            "status": "Alive"
20        }
21        ]
22    }
23    ]
24}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_blb_rs.py

查询应用型blb挂载的后端服务器

查询服务器组下绑定的server。

使用以下代码可以查询应用型blb挂载的后端服务器

函数声明

Plain Text

1    def describe_rs_mount(self, blb_id, sg_id, config=None)

参数含义

请参考OpenAPI文档：查询服务器组下绑定的server

返回值

操作成功：

Plain Text

1{     
2    "backendServerList": [
3    {
4        "instanceId": "BCC_UUID",
5        "privateIp": "192.168.0.1",              
6        "weight": "WEIGHT",
7        "portList": [                            
8        {
9            "listenerPort": "LISTENER_PORT1",
10            "backendPort": "BACKEND_PORT1",
11            "portType": "HTTP",
12            “healthCheckPortType”： "HTTP",
13            "portId": "port_xxx",             
14            "policyId": "policy_xxx",             
15            "status": "Alive"
16        }
17        ]
18    }
19    ]
20}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_rs_mount.py

查询应用型blb未挂载的后端服务器

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

使用以下代码可以查询应用型blb未挂载的后端服务器

函数声明

Plain Text

1    def describe_rs_unmount(self, blb_id, sg_id, config=None)

参数含义

请参考OpenAPI文档：查询服务器组下未绑定的RS

返回值

操作成功：

Plain Text

1{     
2    "backendServerList": [
3    {
4        "instanceId": "BCC_UUID",
5        "privateIp": null,              
6        "weight": null,
7        "portList": []
8    }
9    ]
10}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_rs_unmount.py

绑定普通安全组

为指定LoadBalancer绑定普通安全组

使用以下代码可以绑定普通安全组

函数声明

Plain Text

1def bind_app_security_groups(self, blb_id, securitygroupids,
2                       client_token=None, config=None)

参数含义

请参考OpenAPI文档：BindSecurityGroups绑定普通安全组

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_bind_app_security_groups.py

解绑普通安全组

为指定LoadBalancer解绑普通安全组

使用以下代码可以解绑普通安全组

函数声明

Plain Text

1def unbind_app_security_groups(self, blb_id, securitygroupids,
2                       client_token=None, config=None)

参数含义

请参考OpenAPI文档：UnbindSecurityGroups解绑普通安全组

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_unbind_app_security_groups.py

查询BLB实例普通安全组列表

为指定LoadBalancer查询普通安全组

使用以下代码可以查询普通安全组

函数声明

Plain Text

1def describe_app_security_groups(self, blb_id,
2                       client_token=None, config=None)

参数含义

请参考OpenAPI文档：DescribeSecurityGroups查询BLB实例普通安全组列表

返回值

操作成功：

Plain Text

1{
2    "blbSecurityGroups": [
3        {
4            "securityGroupDesc": "", 
5            "securityGroupId": "g-4NxWoxeq", 
6            "securityGroupName": "securitygroup-name",
7            "vpcName":"vpc-name",
8            "securityGroupRules": [
9                {
10                    "destGroupId": "", 
11                    "destIp": "all", 
12                    "direction": "egress", 
13                    "ethertype": "IPv4", 
14                    "portRange": "1-65535", 
15                    "protocol": "all", 
16                    "securityGroupRuleId": "r-gkv8yupumvx2"
17                }
18            ]
19        }
20    ]
21}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_security_groups.py

绑定企业安全组

为指定LoadBalancer绑定企业安全组

使用以下代码可以绑定企业安全组

函数声明

Plain Text

1def bind_app_enterprise_security_groups(self, blb_id, enterprisesecuritygroupids,
2                                            client_token=None, config=None)

参数含义

请参考OpenAPI文档：BindEnterpriseSecurityGroups绑定企业安全组

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_bind_app_enterprise_security_groups.py

解绑企业安全组

为指定LoadBalancer解绑企业安全组

使用以下代码可以解绑企业安全组 函数声明

Plain Text

1def unbind_app_enterprise_security_groups(self, blb_id, enterprisesecuritygroupids,
2                                              client_token=None, config=None)

参数含义

请参考OpenAPI文档：UnbindEnterpriseSecurityGroups解绑企业安全组

返回值

操作成功：

返回200

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_unbind_app_enterprise_security_groups.py

查询BLB实例企业安全组列表

为指定LoadBalancer查询企业安全组

使用以下代码可以查询企业安全组

函数声明

Plain Text

1def describe_app_enterprise_security_groups(self, blb_id,
2                                                client_token=None, config=None)

参数含义

请参考OpenAPI文档：DescribeEnterpriseSecurityGroups查询BLB实例企业安全组列表

返回值

操作成功：

Plain Text

1{
2  "enterpriseSecurityGroups": [{
3    "enterpriseSecurityGroupId": "esg-g8z4qfj0m0bu",
4    "enterpriseSecurityGroupName": "test0627",
5    "enterpriseSecurityGroupDesc": "",
6    "enterpriseSecurityGroupRules": [{
7            "remark": "全部协议",
8            "direction": "egress",
9            "action": "allow",
10            "priority": 1000,
11            "ethertype": "IPv6",
12            "portRange": "",
13            "sourceIp": "",
14            "destIp": "all",
15            "enterpriseSecurityGroupRuleId": "esgr-9tzd4yijcwqu",
16            "protocol": "all"
17        },
18        {
19            "remark": "",
20            "direction": "egress",
21            "action": "allow",
22            "priority": 1000,
23            "ethertype": "IPv4",
24            "portRange": "",
25            "sourceIp": "",
26            "destIp": "all",
27            "enterpriseSecurityGroupRuleId": "esgr-9je09z6bd9wv",
28            "protocol": "tcp"
29        },
30        {
31            "remark": "",
32            "direction": "ingress",
33            "action": "allow",
34            "priority": 1000,
35            "ethertype": "IPv4",
36            "portRange": "2",
37            "sourceIp": "all",
38            "destIp": "",
39            "enterpriseSecurityGroupRuleId": "esgr-jcej4juqbh49",
40            "protocol": "tcp"
41        }
42    ]}
43}

操作失败：

抛出异常，异常列表参考：异常列表

代码示例

具体代码示例参考：example_describe_app_enterprise_security_groups.py.py

普通型blb实例

IPv6型BLB实例

负载均衡 BLB

应用型blb实例

创建应用型blb实例

更新应用型blb实例

查询应用型blb实例列表

查询应用型blb实例详情

删除应用型blb实例

创建TCP监听器

创建UDP监听器

创建HTTP监听器

创建HTTPS监听器

创建SSL监听器

更新TCP监听器

更新UDP监听器

更新HTTP监听器

更新HTTPS监听器

更新应用型SSL监听器

查询应用型TCP监听器

查询UDP监听器

查询HTTP监听器

查询HTTPS监听器

查询应用型SSL监听器

查询所有监听

释放监听器

创建策略

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

批量删除策略

创建应用型blb服务器组

更新应用型blb服务器组

查询应用型blb服务器组

删除应用型blb服务器组

创建应用型blb服务器组端口

更新应用型blb服务器组端口

删除应用型blb服务器组端口

添加应用型blb后端服务器

更新应用型blb后端服务器

删除应用型blb后端服务器

查询服务器组下的RS信息

查询应用型blb挂载的后端服务器

查询应用型blb未挂载的后端服务器

绑定普通安全组

解绑普通安全组

查询BLB实例普通安全组列表

绑定企业安全组

解绑企业安全组

查询BLB实例企业安全组列表