openstack.load_balancer.v2.load_balancer¶
负载均衡器类¶
The LoadBalancer 类继承自 Resource。
- class openstack.load_balancer.v2.load_balancer.LoadBalancer(_synchronized=False, connection=None, **attrs)¶
基础资源
- 参数：
_synchronized (bool) – 这不打算直接使用。请参阅
new()和existing()。connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None，允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对
self._connection的使用应使用 None 检查进行保护。
- resource_key = 'loadbalancer'¶
资源的单数形式的键。
- resources_key = 'loadbalancers'¶
资源的复数形式的键。
- base_path = '/lbaas/loadbalancers'¶
此资源的 URI 的基本部分。
- allow_create = True¶
允许对此资源进行创建操作。
- allow_fetch = True¶
允许对此资源进行获取操作。
- allow_commit = True¶
允许对此资源进行更新操作。
- allow_delete = True¶
允许对此资源进行删除操作。
- allow_list = True¶
允许对此资源进行列表操作。
- is_admin_state_up¶
负载均衡器的管理状态 类型: bool
- availability_zone¶
目标 Octavia 可用区的名称
- created_at¶
创建负载均衡器的时间戳
- description¶
负载均衡器的描述
- flavor_id¶
负载均衡器的 flavor ID
- listeners¶
与此负载均衡器关联的监听器列表
- name¶
负载均衡器的名称
- operating_status¶
负载均衡器的运行状态
- pools¶
与此负载均衡器关联的 pool 列表
- project_id¶
此负载均衡器关联的项目 ID。
- provider¶
负载均衡器的提供商名称。
- provisioning_status¶
此负载均衡器的配置状态
- updated_at¶
上次更新负载均衡器的时间戳
- vip_address¶
负载均衡器的 VIP 地址
- vip_network_id¶
VIP 网络 ID
- vip_port_id¶
VIP 端口 ID
- vip_subnet_id¶
VIP 子网 ID
- additional_vips¶
附加 VIP
- delete(session, error_message=None, **kwargs)¶
基于此实例删除远程资源。
- 参数：
session (
Adapter) – 用于发出此请求的会话。microversion (str) – 覆盖协商版本使用的 API 版本。
kwargs (dict) – 将传递给 _prepare_request() 的参数
- 返回值:
此
Resource实例。- 引发:
MethodNotSupported如果Resource.allow_commit未设置为True。- 引发:
NotFoundException如果未找到资源。
- failover(session)¶
负载均衡器故障转移。
- 参数：
session – 用于进行此请求的会话。
- 返回值:
无
LoadBalancerStats 类¶
The LoadBalancerStats 类继承自 Resource。
- class openstack.load_balancer.v2.load_balancer.LoadBalancerStats(_synchronized=False, connection=None, **attrs)¶
基础资源
- 参数：
_synchronized (bool) – 这不打算直接使用。请参阅
new()和existing()。connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None，允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对
self._connection的使用应使用 None 检查进行保护。
- resource_key = 'stats'¶
资源的单数形式的键。
- base_path = '/lbaas/loadbalancers/%(lb_id)s/stats'¶
此资源的 URI 的基本部分。
- allow_create = False¶
允许对此资源进行创建操作。
- allow_fetch = True¶
允许对此资源进行获取操作。
- allow_commit = False¶
允许对此资源进行更新操作。
- allow_delete = False¶
允许对此资源进行删除操作。
- allow_list = False¶
允许对此资源进行列表操作。
- lb_id¶
负载均衡器的 ID。
- active_connections¶
当前活动的连接数。
- bytes_in¶
接收到的总字节数。
- bytes_out¶
发送的总字节数。
- request_errors¶
无法完成的总请求数。
- total_connections¶
处理的总连接数。
LoadBalancerFailover 类¶
The LoadBalancerFailover 类继承自 Resource。
- class openstack.load_balancer.v2.load_balancer.LoadBalancerFailover(_synchronized=False, connection=None, **attrs)¶
基础资源
- 参数：
_synchronized (bool) – 这不打算直接使用。请参阅
new()和existing()。connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None，允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对
self._connection的使用应使用 None 检查进行保护。
- base_path = '/lbaas/loadbalancers/%(lb_id)s/failover'¶
此资源的 URI 的基本部分。
- allow_create = False¶
允许对此资源进行创建操作。
- allow_fetch = False¶
允许对此资源进行获取操作。
- allow_commit = True¶
允许对此资源进行更新操作。
- allow_delete = False¶
允许对此资源进行删除操作。
- allow_list = False¶
允许对此资源进行列表操作。
- allow_empty_commit = True¶
提交操作发生在标头或主体未发生更改的情况下。
- requires_id = False¶
此资源调用是否需要 ID
- lb_id¶
负载均衡器的 ID。
- commit(session, prepend_key=True, has_body=False, *args, **kwargs)¶
提交实例的状态到远程资源。
- 参数：
session (
Adapter) – 用于发出此请求的会话。prepend_key – 一个布尔值，指示是否应在资源更新请求中将 resource_key 附加到前面。默认为 True。
retry_on_conflict (bool) – 是否启用在 HTTP CONFLICT (409) 发生时重试。值为
None将使用 Adapter 的默认值。base_path (str) – 修改资源的 URI 的基本部分，如果与
base_path不同。microversion (str) – 覆盖协商版本使用的 API 版本。
kwargs (dict) – 将传递给 _prepare_request() 的参数
- 返回值:
此
Resource实例。- 引发:
MethodNotSupported如果Resource.allow_commit未设置为True。
