负载均衡器 v2 API

负载均衡器类

负载均衡器高级接口通过 Connection 对象中的 load_balancer 成员提供。只有检测到服务时,才会添加 load_balancer 成员。

负载均衡器操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
创建负载均衡器(**attrs)

从属性创建新的负载均衡器

参数:

attrs (dict) – 关键字参数,将用于创建 LoadBalancer,包含 LoadBalancer 类上的属性。

返回值:

负载均衡器创建的结果

返回类型:

LoadBalancer

获取负载均衡器(**attrs)

获取负载均衡器

参数:

load_balancer – 该值可以是负载均衡器的 ID 或 LoadBalancer 实例。

返回值:

一个 LoadBalancer

获取负载均衡器统计信息(load_balancer)

获取负载均衡器的统计信息

参数:

load_balancer – 该值可以是负载均衡器的 ID 或 LoadBalancer 实例。

返回值:

一个 LoadBalancerStats

负载均衡器(**query)

检索负载均衡器生成器

返回值:

负载均衡器实例的生成器

删除负载均衡器(load_balancer, ignore_missing=True, cascade=False)

删除负载均衡器

参数:
  • load_balancer – 负载均衡器可以是 ID 或 LoadBalancer 实例

  • ignore_missing (bool) – 当设置为 False 时,如果负载均衡器不存在,将引发 NotFoundException。当设置为 True 时,尝试删除不存在的负载均衡器时不会设置任何异常。

  • cascade (bool) – 如果为 true,将删除负载均衡器的所有子对象。

返回值:

查找负载均衡器(name_or_id, ignore_missing=True)

查找单个负载均衡器

参数:
  • name_or_id – 负载均衡器的名称或 ID

  • ignore_missing (bool) – 当设置为 False 时,如果负载均衡器不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的负载均衡器时不会设置任何异常。

返回值:

更新负载均衡器(load_balancer, **attrs)

更新负载均衡器

参数:
  • load_balancer – 负载均衡器可以是 ID 或 LoadBalancer 实例

  • attrs (dict) – 要更新由 load_balancer 表示的负载均衡器上的属性。

返回值:

更新后的负载均衡器

返回类型:

LoadBalancer

等待负载均衡器(name_or_id, status='ACTIVE', failures=['ERROR'], interval=2, wait=300)

等待负载均衡器状态

参数:
  • name_or_id – 负载均衡器的名称或 ID。

  • status – 所需状态。

  • failures (list) – 将被解释为失败的状态。默认为 [‘ERROR’]。

  • interval – 连续检查之间的秒数。默认为 2。

  • wait – 在达到所需状态之前等待的最大秒数。默认为 300。

返回值:

成功时返回负载均衡器。

引发:

ResourceTimeout 如果在指定等待时间内未能过渡到所需状态。

引发:

ResourceFailure 如果资源已过渡到其中一个失败状态。

引发:

AttributeError 如果资源没有 status 属性。

负载均衡器故障转移(load_balancer)

负载均衡器故障转移

参数:

load_balancer – 该值可以是负载均衡器的 ID 或 LoadBalancer 实例。

返回值:

监听器操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
创建监听器(**attrs)

从属性创建新的监听器

参数:

attrs (dict) – 关键字参数,将用于创建 Listener,包含 Listener 类上的属性。

返回值:

监听器创建的结果

返回类型:

监听器

删除监听器(listener, ignore_missing=True)

删除一个监听器

参数:
  • listener – 该值可以是监听器的 ID 或 Listener 实例。

  • ignore_missing (bool) – 当设置为 False 时,如果监听器不存在,将引发 NotFoundException。当设置为 True 时,尝试删除不存在的监听器时不会设置任何异常。

返回值:

查找监听器(name_or_id, ignore_missing=True)

查找单个监听器

参数:
  • name_or_id – 监听器的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 Listener 或 None

获取监听器(listener)

获取单个监听器

参数:

listener – 该值可以是监听器的 ID 或 Listener 实例。

返回值:

一个 Listener

引发:

NotFoundException,当找不到资源时。

获取监听器统计信息(listener)

获取监听器的统计信息

参数:

listener – 该值可以是监听器的 ID 或 Listener 实例。

返回值:

一个 ListenerStats

引发:

NotFoundException,当找不到资源时。

监听器(**query)

返回监听器生成器

参数:

query (dict) – 可选查询参数,将发送到服务器以限制返回的资源。有效参数是

返回值:

监听器对象的生成器

返回类型:

监听器

更新监听器(listener, **attrs)

更新一个监听器

参数:
  • listener – 监听器的 id 或 Listener 实例。

  • attrs (dict) – 要更新由 listener 表示的监听器的属性。

返回值:

更新后的监听器

返回类型:

监听器

池操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
创建池(**attrs)

从属性创建新的池

参数:

attrs (dict) – 关键字参数,将用于创建 Pool,包含 Pool 类上的属性。

返回值:

池创建的结果

返回类型:

get_pool(*attrs)

获取一个池

参数:

pool – 值可以是池 ID 或一个 Pool 实例。

返回值:

一个 Pool

pools(**query)

检索池的生成器

返回值:

Pool 实例的生成器

delete_pool(pool, ignore_missing=True)

删除一个池

参数:
  • pool – 池可以是池 ID 或一个 Pool 实例

  • ignore_missing (bool) – 如果设置为 False,当池不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的池时不会设置任何异常。

返回值:

find_pool(name_or_id, ignore_missing=True)

查找单个池

参数:
  • name_or_id – 池的名称或 ID

  • ignore_missing (bool) – 如果设置为 False,当池不存在时将引发 NotFoundException。如果设置为 True,则在尝试查找不存在的池时不会设置任何异常。

返回值:

update_pool(pool, **attrs)

更新一个池

参数:
  • pool – 要么是池的 ID,要么是一个 Pool 实例。

  • attrs (dict) – 要更新到由 pool 表示的池上的属性。

返回值:

更新后的池

返回类型:

成员操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_member(pool, **attrs)

从属性创建新成员

参数:
  • pool – 池可以是池的 ID 或一个 Pool 实例,成员将在其中创建。

  • attrs (dict) – 关键字参数,将用于创建一个 Member,包含 Member 类上的属性。

返回值:

成员创建的结果

返回类型:

成员

delete_member(member, pool, ignore_missing=True)

删除一个成员

参数:
  • member – 成员可以是成员的 ID 或一个 Member 实例。

  • pool – 池可以是池的 ID 或一个 Pool 实例,成员属于该池。

  • ignore_missing (bool) – 如果设置为 False,当成员不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的成员时不会设置任何异常。

返回值:

find_member(name_or_id, pool, ignore_missing=True)

查找单个成员

参数:
  • name_or_id (str) – 成员的名称或 ID。

  • pool – 池可以是池的 ID 或一个 Pool 实例,成员属于该池。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 Member 或 None

get_member(member, pool)

获取单个成员

参数:
  • member – 成员可以是成员的 ID 或一个 Member 实例。

  • pool – 池可以是池的 ID 或一个 Pool 实例,成员属于该池。

返回值:

一个 Member

引发:

NotFoundException,当找不到资源时。

members(pool, **query)

返回成员的生成器

参数:
  • pool – 池可以是池的 ID 或一个 Pool 实例,成员属于该池。

  • query (dict) – 可选查询参数,将发送到服务器以限制返回的资源。有效参数是

返回值:

成员对象的生成器

返回类型:

成员

update_member(member, pool, **attrs)

更新一个成员

参数:
  • member – 要么是成员的 ID,要么是一个 Member 实例。

  • pool – 池可以是池的 ID 或一个 Pool 实例,成员属于该池。

  • attrs (dict) – 要更新到由 member 表示的成员上的属性。

返回值:

更新后的成员

返回类型:

成员

健康监控操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
find_health_monitor(name_or_id, ignore_missing=True)

查找单个健康监控

参数:
  • name_or_id – 健康监控的名称或 ID

  • ignore_missing (bool) – 如果设置为 False,当健康监控不存在时将引发 NotFoundException。如果设置为 True,则在尝试查找不存在的健康监控时不会设置任何异常。

返回值:

匹配给定名称或 ID 的 openstack.load_balancer.v2.healthmonitor.HealthMonitor 对象,或者如果没有匹配项则为 None。

引发:

openstack.exceptions.DuplicateResource 如果此请求找到多个资源。

引发:

openstack.exceptions.NotFoundException 如果未找到任何内容且 ignore_missing 为 False

create_health_monitor(**attrs)

从属性创建新的健康监控

参数:

attrs (dict) – 关键字参数,将用于创建一个 HealthMonitor,包含 HealthMonitor 类上的属性。

返回值:

健康监控创建的结果

返回类型:

HealthMonitor

get_health_monitor(healthmonitor)

获取健康监控

参数:

healthmonitor – 该值可以是健康监控的 ID 或 HealthMonitor 实例。

返回值:

一个健康监控

返回类型:

HealthMonitor

health_monitors(**query)

检索健康监控的生成器

参数:

query (dict) – 可选的查询参数,将发送到服务器以限制返回的资源。有效的参数是:‘name’、‘created_at’、‘updated_at’、‘delay’、‘expected_codes’、‘http_method’、‘max_retries’、‘max_retries_down’、‘pool_id’、‘provisioning_status’、‘operating_status’、‘timeout’、‘project_id’、‘type’、‘url_path’、‘is_admin_state_up’。

返回值:

健康监控实例的生成器

delete_health_monitor(healthmonitor, ignore_missing=True)

删除健康检查

参数:
  • healthmonitor – 健康监控可以是健康监控的 ID 或一个 HealthMonitor 实例

  • ignore_missing (bool) – 如果设置为 False,当健康监控不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的健康监控时不会设置任何异常。

返回值:

update_health_monitor(healthmonitor, **attrs)

更新健康检查

参数:
  • healthmonitor – 健康监控可以是健康监控的 ID 或一个 HealthMonitor 实例

  • attrs (dict) – 要更新到由 healthmonitor 表示的健康监控上的属性。

返回值:

更新后的健康监控

返回类型:

HealthMonitor

L7 策略操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_l7_policy(**attrs)

从属性创建新的 l7policy

参数:

attrs (dict) – 关键字参数,将用于创建一个 L7Policy,包含 L7Policy 类上的属性。

返回值:

l7policy 创建的结果

返回类型:

L7Policy

delete_l7_policy(l7_policy, ignore_missing=True)

删除 l7policy

参数:
  • l7_policy – 该值可以是 l7policy 的 ID 或一个 L7Policy 实例。

  • ignore_missing (bool) – 如果设置为 False,当 l7policy 不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的 l7policy 时不会设置任何异常。

返回值:

find_l7_policy(name_or_id, ignore_missing=True)

查找单个 l7policy

参数:
  • name_or_id – l7policy 的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 L7Policy 或 None

get_l7_policy(l7_policy)

获取单个 l7policy

参数:

l7_policy – 该值可以是 l7policy 的 ID 或一个 L7Policy 实例。

返回值:

一个 L7Policy

引发:

NotFoundException,当找不到资源时。

l7_policies(**query)

返回 l7policies 的生成器

参数:

query (dict) – 可选查询参数,将发送到服务器以限制返回的资源。有效参数是

返回值:

l7policy 对象的生成器

返回类型:

L7Policy

update_l7_policy(l7_policy, **attrs)

更新一个 l7policy

参数:
  • l7_policy – 要么是 l7policy 的 id,要么是 L7Policy 实例。

  • attrs (dict) – 要更新的 l7policy 的属性,由 l7policy 表示。

返回值:

更新后的 l7policy

返回类型:

L7Policy

L7 规则操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_l7_rule(l7_policy, **attrs)

从属性创建新的 l7rule

参数:
  • l7_policy – l7_policy 可以是 l7policy 的 ID,也可以是 L7Policy 实例,l7rule 将被创建在其中。

  • attrs (dict) – 关键字参数,将用于创建 L7Rule,包含 L7Rule 类上的属性。

返回值:

l7rule 创建的结果

返回类型:

L7Rule

delete_l7_rule(l7rule, l7_policy, ignore_missing=True)

删除一个 l7rule

参数:
  • l7rule – l7rule 可以是 l7rule 的 ID,也可以是 L7Rule 实例。

  • l7_policy – l7_policy 可以是 l7policy 的 ID,也可以是 L7Policy 实例,l7rule 属于其中。

  • ignore_missing (bool) – 当设置为 False 时,如果 l7rule 不存在,将引发 NotFoundException。当设置为 True 时,尝试删除不存在的 l7rule 时不会设置任何异常。

返回值:

find_l7_rule(name_or_id, l7_policy, ignore_missing=True)

查找单个 l7rule

参数:
  • name_or_id (str) – l7rule 的名称或 ID。

  • l7_policy – l7_policy 可以是 l7policy 的 ID,也可以是 L7Policy 实例,l7rule 属于其中。

  • ignore_missing (bool) – 当设置为 False 时,如果资源不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的资源时将返回 None。

返回值:

一个 L7Rule 或 None

get_l7_rule(l7rule, l7_policy)

获取单个 l7rule

参数:
  • l7rule – l7rule 可以是 l7rule 的 ID,也可以是 L7Rule 实例。

  • l7_policy – l7_policy 可以是 l7policy 的 ID,也可以是 L7Policy 实例,l7rule 属于其中。

返回值:

一个 L7Rule

引发:

NotFoundException,当找不到资源时。

l7_rules(l7_policy, **query)

返回 l7rule 的生成器

参数:
  • l7_policy – l7_policy 可以是 l7_policy 的 ID,也可以是 L7Policy 实例,l7rule 属于其中。

  • query (dict) – 可选查询参数,将发送到服务器以限制返回的资源。有效参数是

返回值:

l7rule 对象生成器

返回类型:

L7Rule

update_l7_rule(l7rule, l7_policy, **attrs)

更新一个 l7rule

参数:
  • l7rule – 要么是 l7rule 的 ID,要么是 L7Rule 实例。

  • l7_policy – l7_policy 可以是 l7policy 的 ID,也可以是 L7Policy 实例,l7rule 属于其中。

  • attrs (dict) – 要更新的 l7rule 的属性,由 l7rule 表示。

返回值:

更新后的 l7rule

返回类型:

L7Rule

提供程序操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
providers(**query)

检索提供程序生成器

返回值:

提供程序实例生成器

provider_flavor_capabilities(provider, **query)

检索提供程序风味功能生成器

返回值:

提供程序风味功能实例生成器

风味配置文件操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_flavor_profile(**attrs)

从属性创建新的风味配置文件

参数:

attrs (dict) – 关键字参数,将用于创建 FlavorProfile,包含 FlavorProfile 类上的属性。

返回值:

配置文件创建的结果

返回类型:

FlavorProfile

get_flavor_profile(*attrs)

获取风味配置文件

参数:

flavor_profile – 该值可以是风味配置文件的名称或 FlavorProfile 实例。

返回值:

一个 FlavorProfile

flavor_profiles(**query)

检索风味配置文件生成器

返回值:

风味配置文件实例生成器

delete_flavor_profile(flavor_profile, ignore_missing=True)

删除一个 flavor profile

参数:
  • flavor_profile – flavor_profile 可以是 ID,也可以是 FlavorProfile 实例

  • ignore_missing (bool) – 当设置为 False 时,如果风味配置文件不存在,将引发 NotFoundException。当设置为 True 时,尝试删除不存在的风味配置文件时不会设置任何异常。

返回值:

find_flavor_profile(name_or_id, ignore_missing=True)

查找单个风味配置文件

参数:
  • name_or_id – 风味配置文件的名称或 ID

  • ignore_missing (bool) – 当设置为 False 时,如果风味配置文件不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的风味配置文件时不会设置任何异常。

返回值:

update_flavor_profile(flavor_profile, **attrs)

更新一个 flavor profile

参数:
  • flavor_profile – flavor_profile 可以是 ID,也可以是 FlavorProfile 实例

  • attrs (dict) – 要更新的 wind味配置文件属性,由 flavor_profile 表示。

返回值:

更新后的风味配置文件

返回类型:

FlavorProfile

风味操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_flavor(**attrs)

从属性创建新的风味

参数:

attrs (dict) – 关键字参数,将用于创建 Flavor,包含 Flavorclass 上的属性。

返回值:

风味创建的结果

返回类型:

风味

get_flavor(*attrs)

获取风味

参数:

flavor – 该值可以是风味 ID,也可以是 Flavor 实例。

返回值:

一个 Flavor

风味(**查询)

检索风味生成器

返回值:

风味实例生成器

delete_flavor(flavor, ignore_missing=True)

Delete a flavor

参数:
  • flavor – flavor 可以是 ID,也可以是 Flavor 实例

  • ignore_missing (bool) – 当设置为 False 时,如果 flavor 不存在,将引发 NotFoundException。当设置为 True 时,尝试删除不存在的 flavor 时不会设置任何异常。

返回值:

find_flavor(name_or_id, ignore_missing=True)

查找单个风味

参数:
  • name_or_id – 风味的名称或 ID

  • ignore_missing (bool) – 当设置为 False 时,如果风味不存在,将引发 NotFoundException。当设置为 True 时,尝试查找不存在的风味时不会设置任何异常。

返回值:

update_flavor(flavor, **attrs)

更新风味

参数:
  • flavor – flavor 可以是 ID,也可以是 Flavor 实例

  • attrs (dict) – 要更新的 wind味属性,由 flavor 表示。

返回值:

更新后的风味

返回类型:

风味

配额操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
quotas(**query)

返回配额生成器

参数:

query (dict) – 可选查询参数,用于发送到限制返回的资源。目前不支持任何查询参数。

返回值:

配额对象生成器

返回类型:

配额

get_quota(quota)

获取配额

参数:

配额 – 该值可以是配额的 ID,也可以是 Quota 实例。配额的 ID 与该配额的项目 ID 相同。

返回值:

一个 Quota

引发:

NotFoundException,当找不到资源时。

update_quota(quota, **attrs)

更新配额

参数:
  • 配额 – 该值可以是配额的 ID,也可以是 Quota 实例。配额的 ID 与该配额的项目 ID 相同。

  • attrs (dict) – 要更新由 quota 表示的配额上的属性。

返回值:

更新后的配额

返回类型:

配额

get_quota_default()

获取默认配额

返回值:

一个 QuotaDefault

delete_quota(quota, ignore_missing=True)

删除配额(即重置为默认配额)

参数:
  • 配额 – 该值可以是配额的 ID,也可以是 Quota 实例。配额的 ID 与该配额的项目 ID 相同。

  • ignore_missing (bool) – 如果设置为 False,当配额不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的配额时不会设置任何异常。

返回值:

Amphora 操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
amphorae(**query)

检索 Amphora 生成器

返回值:

Amphora 实例生成器

get_amphora(*attrs)

获取 Amphora

参数:

amphora – 该值可以是 Amphora 的 ID 或 Amphora 实例。

返回值:

一个 Amphora

find_amphora(amphora_id, ignore_missing=True)

查找单个 Amphora

参数:
  • amphora_id – Amphora 的 ID

  • ignore_missing (bool) – 如果设置为 False,当 Amphora 不存在时将引发 NotFoundException。如果设置为 True,则在尝试查找不存在的 Amphora 时不会设置任何异常。

返回值:

configure_amphora(amphora_id)

更新 Amphora 代理的配置

参数:

amphora_id – Amphora 的 ID

返回值:

failover_amphora(amphora_id)

故障转移 Amphora

参数:

amphora_id – Amphora 的 ID

返回值:

可用区配置文件操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_availability_zone_profile(**attrs)

从属性创建新的可用区配置文件

参数:

attrs (dict) – 关键字参数,将用于创建由 AvailabilityZoneProfile 类上的属性组成的 AvailabilityZoneProfile

返回值:

配置文件创建的结果

返回类型:

AvailabilityZoneProfile

get_availability_zone_profile(*attrs)

获取可用区配置文件

参数:

availability_zone_profile – 该值可以是可用区配置文件的 ID 或 AvailabilityZoneProfile 实例。

返回值:

一个 AvailabilityZoneProfile

availability_zone_profiles(**query)

检索可用区配置文件生成器

返回值:

可用区配置文件实例生成器

delete_availability_zone_profile(availability_zone_profile, ignore_missing=True)

删除可用区配置文件

参数:
  • availability_zone_profile – 该可用区配置文件可以是 ID 或 AvailabilityZoneProfile 实例

  • ignore_missing (bool) – 如果设置为 False,当可用区配置文件不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的可用区配置文件时不会设置任何异常。

返回值:

find_availability_zone_profile(name_or_id, ignore_missing=True)

查找单个可用区配置文件

参数:
  • name_or_id – 可用区配置文件的名称或 ID

  • ignore_missing (bool) – 如果设置为 False,当可用区配置文件不存在时将引发 NotFoundException。如果设置为 True,则在尝试查找不存在的可用区配置文件时不会设置任何异常。

返回值:

update_availability_zone_profile(availability_zone_profile, **attrs)

更新可用区配置文件

参数:
  • availability_zone_profile – 该可用区配置文件可以是 ID 或 AvailabilityZoneProfile 实例

  • attrs (dict) – 要更新由 availability_zone_profile 表示的可用区配置文件上的属性。

返回值:

更新后的可用区配置文件

返回类型:

AvailabilityZoneProfile

可用区操作

class openstack.load_balancer.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_availability_zone(**attrs)

从属性创建新的可用区

参数:

attrs (dict) – 关键字参数,将用于创建由 AvailabilityZone 类上的属性组成的 AvailabilityZone

返回值:

可用区创建的结果

返回类型:

AvailabilityZone

get_availability_zone(*attrs)

获取可用区

参数:

availability_zone – 该值可以是可用区的 ID 或 AvailabilityZone 实例。

返回值:

一个 AvailabilityZone

availability_zones(**query)

检索可用区生成器

返回值:

可用区实例生成器

delete_availability_zone(availability_zone, ignore_missing=True)

删除可用区

参数:
  • availability_zone – 该可用区可以是 ID 或 AvailabilityZone 实例

  • ignore_missing (bool) – 如果设置为 False,当可用区不存在时将引发 NotFoundException。如果设置为 True,则在尝试删除不存在的可用区时不会设置任何异常。

返回值:

find_availability_zone(name_or_id, ignore_missing=True)

查找单个可用区

参数:
  • name_or_id – 可用区的名称或 ID

  • ignore_missing (bool) – 如果设置为 False,当可用区不存在时将引发 NotFoundException。如果设置为 True,则在尝试查找不存在的可用区时不会设置任何异常。

返回值:

update_availability_zone(availability_zone, **attrs)

更新一个可用区

参数:
  • availability_zone – 该可用区可以是 ID 或 AvailabilityZone 实例

  • attrs (dict) – 要更新由 availability_zone 表示的可用区上的属性。

返回值:

更新后的可用区

返回类型:

AvailabilityZone