网络 API

update_router(router, if_revision=None, **attrs)

更新路由器

参数：

router – 要么是路由器的 ID，要么是 Router 实例。
if_revision (int) – 要放在更新请求的 If-Match 标头中的修订号，以执行比较和交换更新。
attrs – 要更新由 router 表示的路由器的属性。

返回值:

更新后的路由器

返回类型:

add_interface_to_router(router, subnet_id=None, port_id=None)

向路由器添加接口

参数：

router – 要么是路由器 ID，要么是 Router 的实例
subnet_id – 子网的 ID
port_id – 端口的 ID

返回值:

具有更新接口的路由器

返回类型:

remove_interface_from_router(router, subnet_id=None, port_id=None)

从路由器删除接口

参数：

router – 要么是路由器 ID，要么是 Router 的实例
subnet – 子网的 ID
port – 端口的 ID

返回值:

具有更新接口的路由器

返回类型:

add_extra_routes_to_router(router, body)

向路由器添加额外的路由

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 如 api-ref 中所述的请求体。

返回值:

具有更新的额外路由的路由器

返回类型:

remove_extra_routes_from_router(router, body)

从路由器删除额外的路由

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 如 api-ref 中所述的请求体。

返回值:

具有更新的额外路由的路由器

返回类型:

add_gateway_to_router(router, **body)

向路由器添加网关

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 包含网关信息的体

返回值:

具有更新接口的路由器

返回类型:

remove_gateway_from_router(router, **body)

从路由器删除网关

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 包含网关信息的体

返回值:

具有更新接口的路由器

返回类型:

add_external_gateways(router, body)

添加路由器外部网关

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 包含 external_gateways 参数的体。

返回值:

添加网关的路由器

返回类型:

update_external_gateways(router, body)

更新路由器外部网关

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 包含 external_gateways 参数的体。

返回值:

更新网关的路由器

返回类型:

remove_external_gateways(router, body)

删除路由器外部网关

参数：

router – 要么是路由器 ID，要么是 Router 的实例
body – 包含 external_gateways 参数的体。

返回值:

删除网关的路由器

返回类型:

create_conntrack_helper(router, **attrs)

从属性创建新的 L3 conntrack helper

参数：

router – 要么是路由器 ID，要么是 Router 的实例
attrs – 将用于创建 ConntrackHelper 的关键字参数，包含 ConntrackHelper 类上的属性。

返回值:

conntrack helper 创建的结果

返回类型:

ConntrackHelper

conntrack_helpers(router, **query)

返回 conntrack helper 生成器

参数：

router – 要么是路由器 ID，要么是 Router 的实例
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

conntrack helper 对象生成器

返回类型:

ConntrackHelper

get_conntrack_helper(conntrack_helper, router)

获取单个 L3 conntrack helper

参数：

conntrack_helper – 该值可以是 L3 conntrack helper 的 ID 或 ConntrackHelper 实例。
router – 该值可以是 Router 的 ID 或 Router 实例。

返回值:

一个 ConntrackHelper

引发:

NotFoundException，当找不到资源时。

update_conntrack_helper(conntrack_helper, router, **attrs)

更新 L3 conntrack_helper

参数：

conntrack_helper – 该值可以是 L3 conntrack helper 的 ID 或 ConntrackHelper 实例。
router – 该值可以是 Router 的 ID 或 Router 实例。
attrs – 要更新由 conntrack_helper 表示的 L3 conntrack helper 的属性。

返回值:

更新后的 conntrack helper

返回类型:

ConntrackHelper

delete_conntrack_helper(conntrack_helper, router, ignore_missing=True)

删除 L3 conntrack_helper

参数：

conntrack_helper – 该值可以是 L3 conntrack helper 的 ID 或 ConntrackHelper 实例。
router – 该值可以是 Router 的 ID 或 Router 实例。
ignore_missing (bool) – 如果设置为 False，当浮动 IP 不存在时会引发 NotFoundException。如果设置为 True，则在尝试删除不存在的 IP 时不会设置任何异常。

返回值:

无

浮动 IP 操作¶

create_ip(**attrs)

从属性创建新的浮动 IP

参数：: attrs – 关键字参数，将用于创建 FloatingIP，包含 FloatingIP 类上的属性。
返回值:: 浮动 IP 创建的结果
返回类型:: FloatingIP

delete_ip(floating_ip, ignore_missing=True, if_revision=None)

删除浮动 IP

参数：

floating_ip – 该值可以是浮动 IP 的 ID 或 FloatingIP 实例。
ignore_missing (bool) – 如果设置为 False，当浮动 IP 不存在时会引发 NotFoundException。如果设置为 True，则在尝试删除不存在的 IP 时不会设置任何异常。
if_revision (int) – 要放在更新请求的 If-Match 标头中的修订号，以执行比较和交换更新。

返回值:

无

find_available_ip()

查找可用的 IP

返回值:: 一个 FloatingIP 或 None

find_ip(name_or_id, ignore_missing=True, **query)

查找单个 IP

参数：

name_or_id – IP 的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 FloatingIP 或 None

get_ip(floating_ip)

获取单个浮动 IP

参数：: floating_ip – 该值可以是浮动 IP 的 ID 或 FloatingIP 实例。
返回值:: 一个 FloatingIP
引发:: NotFoundException，当找不到资源时。

ips(**query)

返回 IP 生成器

参数：

query (dict) –

可选查询参数，用于发送到服务器以限制返回的资源。有效参数是

description：浮动 IP 的描述。
fixed_ip_address：与浮动 IP 地址关联的固定 IP 地址。
floating_ip_address：浮动 IP 的 IP 地址。
floating_network_id：与浮动 IP 关联的网络 ID。
port_id：浮动 IP 关联的端口的 ID。
project_id：浮动 IP 关联的项目 ID。
router_id：关联路由器的 ID。
status：浮动 IP 的状态，可以是 ACTIVE 或 DOWN。

返回值:

浮动 IP 对象生成器

返回类型:

FloatingIP

update_ip(floating_ip, if_revision=None, **attrs)

更新 IP

参数：

floating_ip – IP 的 ID 或 FloatingIP 实例。
if_revision (int) – 要放在更新请求的 If-Match 标头中的修订号，以执行比较和交换更新。
attrs – 要更新 value 所表示的 IP 上的属性。

返回值:

更新后的 IP

返回类型:

FloatingIP

池操作¶

create_pool(**attrs)

从属性创建新的池

参数：: attrs – 关键字参数，将用于创建 Pool，包含 Pool 类上的属性。
返回值:: 池创建的结果
返回类型:: 池

delete_pool(pool, ignore_missing=True)

删除一个池

参数：

pool – 该值可以是池的 ID 或 Pool 实例。
ignore_missing (bool) – 如果设置为 False，当池不存在时会引发 NotFoundException。如果设置为 True，则在尝试删除不存在的池时不会设置任何异常。

返回值:

无

find_pool(name_or_id, ignore_missing=True, **query)

查找单个池

参数：

name_or_id – 池的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 Pool 或 None

get_pool(pool)

获取单个池

参数：: pool – 该值可以是池的 ID 或 Pool 实例。
返回值:: 一个 Pool
引发:: NotFoundException，当找不到资源时。

pools(**query)

返回池生成器

参数：

query (dict) –

可选查询参数，用于发送到服务器以限制返回的资源。有效参数是

description：池的描述。
is_admin_state_up：池的管理状态。
lb_algorithm：使用的负载均衡算法，可以是 round-robin、least-connections 等。
name：节点池的名称。
project_id：池关联的项目 ID。
protocol：池使用的协议，可以是 TCP、HTTP 或 HTTPS。
provider：负载均衡服务的提供商名称。
subnet_id：池成员所在的子网。
virtual_ip_id：使用的虚拟 IP 的 ID。

返回值:

池对象生成器

返回类型:

池

update_pool(pool, **attrs)

更新一个池

参数：

pool – 池的 ID 或 Pool 实例。
attrs – 要更新 pool 所表示的池上的属性。

返回值:

更新后的池

返回类型:

池

create_pool_member(pool, **attrs)

从属性创建新的池成员

参数：

pool – 池可以是池的 ID 或 Pool 实例，成员将在其中创建。
attrs – 关键字参数，将用于创建 PoolMember，包含 PoolMember 类上的属性。

返回值:

池成员创建的结果

返回类型:

PoolMember

delete_pool_member(pool_member, pool, ignore_missing=True)

删除池成员

参数：

pool_member – 成员可以是池成员的 ID 或 PoolMember 实例。
pool – 池可以是池的 ID 或 Pool 实例，成员属于该池。
ignore_missing (bool) – 如果设置为 False，当池成员不存在时会引发 NotFoundException。如果设置为 True，则在尝试删除不存在的池成员时不会设置任何异常。

返回值:

无

find_pool_member(name_or_id, pool, ignore_missing=True, **query)

查找单个池成员

参数：

name_or_id (str) – 池成员的名称或 ID。
pool – 池可以是池的 ID 或 Pool 实例，成员属于该池。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 PoolMember 或 None

get_pool_member(pool_member, pool)

获取单个池成员

参数：

pool_member – 该成员可以是池成员的 ID，也可以是 PoolMember 实例。
pool – 池可以是池的 ID 或 Pool 实例，成员属于该池。

返回值:

一个 PoolMember

引发:

NotFoundException，当找不到资源时。

pool_members(pool, **query)

返回池成员的生成器

参数：

pool – 池可以是池的 ID 或 Pool 实例，成员属于该池。
query (dict) –
可选查询参数，用于发送到服务器以限制返回的资源。有效参数是
- address: 池成员的 IP 地址。
- is_admin_state_up: 池成员的管理状态。
- name: 池成员的名称。
- project_id: 该池成员关联的项目 ID。
- protocol_port: 应用程序托管的端口。
- subnet_id: 访问此池成员的子网 ID。
- weight: 一个正整数值，表示池应从该成员接收的流量的相对比例。

返回值:

池成员对象的生成器

返回类型:

PoolMember

update_pool_member(pool_member, pool, **attrs)

更新池成员

参数：

pool_member – 池成员的 ID 或 PoolMember 实例。
pool – 池可以是池的 ID 或 Pool 实例，成员属于该池。
attrs – 要更新的池成员属性，由 pool_member 表示。

返回值:

更新后的池成员

返回类型:

PoolMember

自动分配拓扑操作¶

get_auto_allocated_topology(project=None)

获取给定租户的自动分配拓扑

参数：: project – 该值为项目 ID 或名称
返回值:: 自动分配的拓扑
返回类型:: AutoAllocatedTopology

delete_auto_allocated_topology(project=None, ignore_missing=False)

删除自动分配的拓扑

参数：

project – 该值为项目 ID 或名称
ignore_missing – 当设置为 False 时，如果拓扑不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的拓扑时不会引发异常

返回值:

无

validate_auto_allocated_topology(project=None)

验证自动分配的资源

参数：: project – 该值为项目 ID 或名称
返回值:: 是否所有资源都已正确配置
返回类型:: ValidateTopology

默认安全组规则操作¶

create_default_security_group_rule(**attrs)

从属性创建新的默认安全组规则

参数：: attrs – 关键字参数，将用于创建 DefaultSecurityGroupRule，包含 DefaultSecurityGroupRule 类上的属性。
返回值:: 默认安全组规则创建的结果
返回类型:: DefaultSecurityGroupRule

delete_default_security_group_rule(default_security_group_rule, ignore_missing=True)

删除默认安全组规则

参数：

default_security_group_rule – 该值可以是默认安全组规则的 ID 或 DefaultSecurityGroupRule 实例。
ignore_missing (bool) – 当设置为 False 时，如果默认安全组规则不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的默认安全组规则时不会设置异常。

返回值:

无

find_default_security_group_rule(name_or_id, ignore_missing=True, **query)

查找单个默认安全组规则

参数：

name_or_id (str) – 默认安全组规则的 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 DefaultSecurityGroupRule 或 None

get_default_security_group_rule(default_security_group_rule)

获取单个默认安全组规则

参数：: default_security_group_rule – 该值可以是默认安全组规则的 ID 或 DefaultSecurityGroupRule 实例。
返回值:: DefaultSecurityGroupRule
引发:: NotFoundException，当找不到资源时。

default_security_group_rules(**query)

返回默认安全组规则的生成器

参数：

query (kwargs) –

可选的查询参数，用于发送到限制返回资源的底层方法。可用的参数包括

description: 默认安全组规则描述
direction: 默认安全组规则方向
ether_type: 必须为 IPv4 或 IPv6，并且以 CIDR 表示的地址必须与入站或出站规则匹配。
protocol: 默认安全组规则协议
remote_group_id: 远程安全组的 ID

返回值:

默认安全组规则对象的生成器

返回类型:

DefaultSecurityGroupRule

安全组操作¶

create_security_group(**attrs)

从属性创建新的安全组

参数：: attrs – 关键字参数，将用于创建 SecurityGroup，包含 SecurityGroup 类上的属性。
返回值:: 安全组创建的结果
返回类型:: SecurityGroup

delete_security_group(security_group, ignore_missing=True, if_revision=None)

删除一个安全组

参数：

security_group – 该值可以是安全组的 ID 或 SecurityGroup 实例。
ignore_missing (bool) – 当设置为 False 时，如果安全组不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的安全组时不会设置异常。
if_revision (int) – 要放在更新请求的 If-Match 标头中的修订号，以执行比较和交换更新。

返回值:

无

find_security_group(name_or_id, ignore_missing=True, **query)

查找单个安全组

参数：

name_or_id – 安全组的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 SecurityGroup 或 None

get_security_group(security_group)

获取单个安全组

参数：: security_group – 该值可以是安全组的 ID 或 SecurityGroup 实例。
返回值:: 一个 SecurityGroup
引发:: NotFoundException，当找不到资源时。

security_groups(**query)

返回安全组的生成器

参数：

query (dict) –

可选查询参数，用于发送到服务器以限制返回的资源。有效参数是

description: 安全组描述
ìd: 安全组的 ID，或安全组 ID 列表
name: 安全组的名称
project_id: 该安全组关联的项目 ID。

返回值:

安全组对象的生成器

返回类型:

SecurityGroup

update_security_group(security_group, if_revision=None, **attrs)

更新一个安全组

参数：

security_group – 要么是安全组的 ID，要么是 SecurityGroup 实例。
if_revision (int) – 要放在更新请求的 If-Match 标头中的修订号，以执行比较和交换更新。
attrs – 要更新的由 security_group 表示的安全组的属性。

返回值:

更新后的安全组

返回类型:

SecurityGroup

create_security_group_rule(**attrs)

从属性创建新的安全组规则

参数：: attrs – 关键字参数，将用于创建 SecurityGroupRule，包含 SecurityGroupRule 类上的属性。
返回值:: 安全组规则创建的结果
返回类型:: SecurityGroupRule

create_security_group_rules(data)

从属性列表中创建新的安全组规则

参数：: data (list) – 将用于创建 SecurityGroupRule 的属性字典列表，包含 SecurityGroupRule 类中的属性。
返回值:: 安全组规则对象生成器
返回类型:: SecurityGroupRule

delete_security_group_rule(security_group_rule, ignore_missing=True, if_revision=None)

删除一个安全组规则

参数：

security_group_rule – 该值可以是安全组规则的 ID，也可以是 SecurityGroupRule 实例。
ignore_missing (bool) – 当设置为 False 时，如果安全组规则不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的安全组规则将不会引发异常。
if_revision (int) – 要放在更新请求的 If-Match 标头中的修订号，以执行比较和交换更新。

返回值:

无

find_security_group_rule(name_or_id, ignore_missing=True, **query)

查找单个安全组规则

参数：

name_or_id (str) – 安全组规则的 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 SecurityGroupRule 或 None

get_security_group_rule(security_group_rule)

获取单个安全组规则

参数：: security_group_rule – 该值可以是安全组规则的 ID，也可以是 SecurityGroupRule 实例。
返回值:: SecurityGroupRule
引发:: NotFoundException，当找不到资源时。

security_group_rules(**query)

返回安全组规则生成器

参数：

query (kwargs) –

可选的查询参数，用于发送到限制返回资源的底层方法。可用的参数包括

description：安全组规则描述
direction：安全组规则方向
ether_type: 必须为 IPv4 或 IPv6，并且以 CIDR 表示的地址必须与入站或出站规则匹配。
project_id：此安全组规则关联的项目 ID。
protocol：安全组规则协议
remote_group_id: 远程安全组的 ID
security_group_id：拥有规则的安全组 ID

返回值:

安全组规则对象生成器

返回类型:

SecurityGroupRule

地址组操作¶

create_address_group(**attrs)

从属性创建新的地址组

参数：: attrs – 关键字参数，将用于创建 AddressGroup，包含 AddressGroup 类中的属性。
返回值:: 地址组创建结果
返回类型:: AddressGroup

delete_address_group(address_group, ignore_missing=True)

删除地址组

参数：

address_group – 该值可以是地址组的 ID，也可以是 AddressGroup 实例。
ignore_missing (bool) – 当设置为 False 时，如果地址组不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的地址组将不会引发异常。

返回值:

无

find_address_group(name_or_id, ignore_missing=True, **query)

查找单个地址组

参数：

name_or_id – 地址组的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 AddressGroup 或 None

get_address_group(address_group)

获取单个地址组

参数：: address_group – 该值可以是地址组的 ID，也可以是 AddressGroup 实例。
返回值:: 一个 AddressGroup
引发:: NotFoundException，当找不到资源时。

address_groups(**query)

返回地址组生成器

参数：

query (dict) –

可选查询参数，用于限制返回的资源。

name：地址组名称
description：地址组描述
project_id：所有者项目 ID

返回值:

地址组对象生成器

返回类型:

update_address_group(address_group, **attrs)

更新地址组

参数：

address_group – 地址组的 ID 或 AddressGroup 实例。
attrs – 要更新由 value 表示的地址组上的属性。

返回值:

更新后的地址组

返回类型:

add_addresses_to_address_group(address_group, addresses)

将地址添加到地址组

参数：

address_group – 地址组的 ID 或 AddressGroup 实例。
addresses (list) – 地址字符串列表。

返回值:

包含更新后地址的 AddressGroup

返回类型:

remove_addresses_from_address_group(address_group, addresses)

从地址组中删除地址

参数：

address_group – 地址组的 ID 或 AddressGroup 实例。
addresses (list) – 地址字符串列表。

返回值:

包含更新后地址的 AddressGroup

返回类型:

QoSMinimumBandwidthRule

可用区操作¶

availability_zones(**query)

返回可用区的生成器

参数：

query (dict) –

可选查询参数，用于设置限制返回资源的参数。有效参数包括

name：可用区的名称。
resource：可用区的资源类型。

返回值:

可用区对象生成器

返回类型:

AvailabilityZone

地址范围操作¶

create_address_scope(**attrs)

从属性创建新的地址范围

参数：: attrs – 关键字参数，将用于创建 AddressScope，包含 AddressScope 类中的属性。
返回值:: 地址范围创建结果
返回类型:: AddressScope

delete_address_scope(address_scope, ignore_missing=True)

删除地址范围

参数：

address_scope – 该值可以是地址范围的 ID，也可以是 AddressScope 实例。
ignore_missing (bool) – 当设置为 False 时，如果地址范围不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的地址范围将不会引发异常。

返回值:

无

find_address_scope(name_or_id, ignore_missing=True, **query)

查找单个地址范围

参数：

name_or_id – 地址范围的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 AddressScope 或 None

get_address_scope(address_scope)

获取单个地址范围

参数：: address_scope – 该值可以是地址范围的 ID，也可以是 AddressScope 实例。
返回值:: 一个 AddressScope
引发:: NotFoundException，当找不到资源时。

address_scopes(**query)

返回地址范围生成器

参数：

query (dict) –

可选查询参数，用于限制返回的资源。

name：地址范围名称
ip_version：地址范围 IP 地址版本
tenant_id：所有者租户 ID
shared：地址范围是否共享（布尔值）

返回值:

地址范围对象生成器

返回类型:

AddressScope

update_address_scope(address_scope, **attrs)

更新地址范围

参数：

address_scope – 地址范围的 ID 或 AddressScope 实例。
attrs – 要更新由 value 表示的地址范围上的属性。

返回值:

更新后的地址范围

返回类型:

AddressScope

配额操作¶

delete_quota(quota, ignore_missing=True)

删除配额（即重置为默认配额）

参数：

quota – 该值可以是配额的 ID，也可以是 Quota 实例。配额的 ID 与配额的项目 ID 相同。
ignore_missing (bool) – 当设置为 False 时，如果配额不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的配额将不会引发异常。

返回值:

无

get_quota(quota, details=False)

获取配额

参数：

配额 – 该值可以是配额的 ID，也可以是 Quota 实例。配额的 ID 与该配额的项目 ID 相同。
details – 如果设置为 True，将返回配额使用情况的详细信息。

返回值:

一个 Quota

引发:

NotFoundException，当找不到资源时。

get_quota_default(quota)

获取默认配额

参数：: quota – 该值可以是默认配额的 ID，也可以是 QuotaDefault 实例。默认配额的 ID 与该默认配额的项目 ID 相同。
返回值:: 一个 QuotaDefault
引发:: NotFoundException，当找不到资源时。

quotas(**query)

返回配额生成器

参数：: query (dict) – 可选的查询参数，用于限制返回的资源。目前不支持任何查询参数。
返回值:: 配额对象生成器
返回类型:: 配额

update_quota(quota, **attrs)

更新配额

参数：

quota – 可以是配额的 ID，也可以是 Quota 实例。配额的 ID 与该配额的项目 ID 相同。
attrs – 要更新由 quota 表示的配额的属性。

返回值:

更新后的配额

返回类型:

配额

QoS 操作¶

create_qos_bandwidth_limit_rule(qos_policy, **attrs)

创建新的带宽限制规则

参数：

attrs – 关键字参数，将用于创建 QoSBandwidthLimitRule，包含 QoSBandwidthLimitRule 类上的属性。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

资源创建的结果

返回类型:

QoSBandwidthLimitRule

delete_qos_bandwidth_limit_rule(qos_rule, qos_policy, ignore_missing=True)

删除带宽限制规则

参数：

qos_rule – 该值可以是带宽限制规则的 ID，也可以是 QoSBandwidthLimitRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的带宽限制规则时不会设置任何异常。

返回值:

无

find_qos_bandwidth_limit_rule(qos_rule_id, qos_policy, ignore_missing=True, **query)

查找带宽限制规则

参数：

qos_rule_id – 带宽限制规则的 ID。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 QoSBandwidthLimitRule 或 None

get_qos_bandwidth_limit_rule(qos_rule, qos_policy)

获取单个带宽限制规则

参数：

qos_rule – 该值可以是最小带宽规则的 ID，也可以是 QoSBandwidthLimitRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

一个 QoSBandwidthLimitRule

引发:

NotFoundException，当找不到资源时。

qos_bandwidth_limit_rules(qos_policy, **query)

返回带宽限制规则生成器

参数：

qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

带宽限制规则对象生成器

返回类型:

QoSBandwidthLimitRule

update_qos_bandwidth_limit_rule(qos_rule, qos_policy, **attrs)

更新带宽限制规则

参数：

qos_rule – 可以是带宽限制规则的 ID，也可以是 QoSBandwidthLimitRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
attrs – 要更新由 qos_rule 表示的带宽限制规则的属性。

返回值:

更新后的最小带宽规则

返回类型:

QoSBandwidthLimitRule

create_qos_dscp_marking_rule(qos_policy, **attrs)

创建新的 QoS DSCP 标记规则

参数：

attrs – 关键字参数，将用于创建 QoSDSCPMarkingRule，包含 QosDscpMarkingRule 类上的属性。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

路由器创建的结果

返回类型:

QoSDSCPMarkingRule

delete_qos_dscp_marking_rule(qos_rule, qos_policy, ignore_missing=True)

删除 QoS DSCP 标记规则

参数：

qos_rule – 该值可以是最小带宽规则的 ID，也可以是 QoSDSCPMarkingRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的最小带宽规则时不会设置任何异常。

返回值:

无

find_qos_dscp_marking_rule(qos_rule_id, qos_policy, ignore_missing=True, **query)

查找 QoS DSCP 标记规则

参数：

qos_rule_id – QoS DSCP 标记规则的 ID。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 QoSDSCPMarkingRule 或 None

get_qos_dscp_marking_rule(qos_rule, qos_policy)

获取单个 QoS DSCP 标记规则

参数：

qos_rule – 该值可以是最小带宽规则的 ID，也可以是 QoSDSCPMarkingRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

一个 QoSDSCPMarkingRule

引发:

NotFoundException，当找不到资源时。

qos_dscp_marking_rules(qos_policy, **query)

返回 QoS DSCP 标记规则生成器

参数：

qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

QoS DSCP 标记规则对象生成器

返回类型:

QoSDSCPMarkingRule

update_qos_dscp_marking_rule(qos_rule, qos_policy, **attrs)

更新 QoS DSCP 标记规则

参数：

qos_rule – 可以是最小带宽规则的 ID，也可以是 QoSDSCPMarkingRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
attrs – 要更新由 qos_rule 表示的 QoS DSCP 标记规则的属性。

返回值:

更新后的 QoS DSCP 标记规则

返回类型:

QoSDSCPMarkingRule

create_qos_minimum_bandwidth_rule(qos_policy, **attrs)

创建新的最小带宽规则

参数：

attrs – 关键字参数，将用于创建 QoSMinimumBandwidthRule，包含 QoSMinimumBandwidthRule 类上的属性。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

资源创建的结果

返回类型:

delete_qos_minimum_bandwidth_rule(qos_rule, qos_policy, ignore_missing=True)

删除最小带宽规则

参数：

qos_rule – 该值可以是最小带宽规则的 ID，也可以是 QoSMinimumBandwidthRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的最小带宽规则时不会设置任何异常。

返回值:

无

find_qos_minimum_bandwidth_rule(qos_rule_id, qos_policy, ignore_missing=True, **query)

查找最小带宽规则

参数：

qos_rule_id – 最小带宽规则的 ID。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 QoSMinimumBandwidthRule 或 None

get_qos_minimum_bandwidth_rule(qos_rule, qos_policy)

获取单个最小带宽规则

参数：

qos_rule – 该值可以是最小带宽规则的 ID，也可以是 QoSMinimumBandwidthRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

一个 QoSMinimumBandwidthRule

引发:

NotFoundException，当找不到资源时。

qos_minimum_bandwidth_rules(qos_policy, **query)

返回最小带宽规则的生成器

参数：

qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

最小带宽规则对象的生成器

返回类型:

QoSMinimumBandwidthRule

update_qos_minimum_bandwidth_rule(qos_rule, qos_policy, **attrs)

更新最小带宽规则

参数：

qos_rule – 可以是最小带宽规则的 ID，也可以是 QoSMinimumBandwidthRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
attrs – 要更新由 qos_rule 表示的最小带宽规则的属性。

返回值:

更新后的最小带宽规则

返回类型:

QoSMinimumBandwidthRule

create_qos_minimum_packet_rate_rule(qos_policy, **attrs)

创建一个新的最小包速率规则

参数：

attrs – 关键字参数，将用于创建 QoSMinimumPacketRateRule，包含 QoSPacketRateRule 类的属性。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

资源创建的结果

返回类型:

QoSMinimumPacketRateRule

delete_qos_minimum_packet_rate_rule(qos_rule, qos_policy, ignore_missing=True)

删除最小包速率规则

参数：

qos_rule – 该值可以是最小包速率规则的 ID，也可以是 QoSMinimumPacketRateRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 如果设置为 False，当资源不存在时将引发 NotFoundException。如果设置为 True，则尝试删除不存在的最小包速率规则时不会引发异常。

返回值:

无

find_qos_minimum_packet_rate_rule(qos_rule_id, qos_policy, ignore_missing=True, **query)

查找最小包速率规则

参数：

qos_rule_id – 最小包速率规则的 ID。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 QoSMinimumPacketRateRule 或 None

get_qos_minimum_packet_rate_rule(qos_rule, qos_policy)

获取单个最小包速率规则

参数：

qos_rule – 该值可以是最小包速率规则的 ID，也可以是 QoSMinimumPacketRateRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

一个 QoSMinimumPacketRateRule

引发:

NotFoundException，当找不到资源时。

qos_minimum_packet_rate_rules(qos_policy, **query)

返回最小包速率规则的生成器

参数：

qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

最小包速率规则对象的生成器

返回类型:

QoSMinimumPacketRateRule

update_qos_minimum_packet_rate_rule(qos_rule, qos_policy, **attrs)

更新最小包速率规则

参数：

qos_rule – 可以是最小包速率规则的 ID，也可以是 QoSMinimumPacketRateRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
attrs – 要更新由 qos_rule 表示的最小包速率规则的属性。

返回值:

更新后的最小包速率规则

返回类型:

QoSMinimumPacketRateRule

create_qos_packet_rate_limit_rule(qos_policy, **attrs)

创建一个新的包速率限制规则

参数：

attrs – 关键字参数，将用于创建 QoSPacketRateLimitRule，包含 QoSPacketRateLimitRule 类的属性。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

资源创建的结果

返回类型:

QoSPacketRateLimitRule

delete_qos_packet_rate_limit_rule(qos_rule, qos_policy, ignore_missing=True)

删除包速率限制规则

参数：

qos_rule – 该值可以是包速率限制规则的 ID，也可以是 QoSPacketRateLimitRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 如果设置为 False，当资源不存在时将引发 NotFoundException。如果设置为 True，则尝试删除不存在的最小包速率规则时不会引发异常。

返回值:

无

find_qos_packet_rate_limit_rule(qos_rule_id, qos_policy, ignore_missing=True, **query)

查找包速率限制规则

参数：

qos_rule_id – 包速率限制规则的 ID。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 QoSPacketRateLimitRule 或 None

get_qos_packet_rate_limit_rule(qos_rule, qos_policy)

获取单个包速率限制规则

参数：

qos_rule – 该值可以是包速率限制规则的 ID，也可以是 QoSPacketRateLimitRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。

返回值:

一个 QoSPacketRateLimitRule

引发:

NotFoundException，当找不到资源时。

update_qos_packet_rate_limit_rule(qos_rule, qos_policy, **attrs)

更新最小包速率规则

参数：

qos_rule – 可以是最小包速率规则的 ID，也可以是 QoSPacketRateLimitRule 实例。
qos_policy – 该值可以是规则所属的 QoS 策略的 ID，也可以是 QoSPolicy 实例。
attrs – 要更新由 qos_rule 表示的最小包速率规则的属性。

返回值:

更新后的最小包速率规则

返回类型:

QoSPacketRateLimitRule

create_qos_policy(**attrs)

从属性创建新的 QoS 策略

参数：: attrs – 关键字参数，将用于创建 QoSPolicy，包含 QoSPolicy 类的属性。
返回值:: QoS 策略创建的结果
返回类型:: QoSPolicy

delete_qos_policy(qos_policy, ignore_missing=True)

删除 QoS 策略

参数：

qos_policy – 该值可以是 QoS 策略的 ID，也可以是 QoSPolicy 实例。
ignore_missing (bool) – 如果设置为 False，当 QoS 策略不存在时将引发 NotFoundException。如果设置为 True，则尝试删除不存在的 QoS 策略时不会引发异常。

返回值:

无

find_qos_policy(name_or_id, ignore_missing=True, **query)

查找单个 QoS 策略

参数：

name_or_id – QoS 策略的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。
query (dict) – 任何要传递到底层方法的其他参数，例如查询过滤器。

返回值:

一个 QoSPolicy 或 None

get_qos_policy(qos_policy)

获取单个 QoS 策略

参数：: qos_policy – 该值可以是 QoS 策略的 ID，也可以是 QoSPolicy 实例。
返回值:: 一个 QoSPolicy
引发:: NotFoundException，当找不到资源时。

qos_policies(**query)

返回 QoS 策略的生成器

参数：

query (dict) –

可选查询参数，用于发送到服务器以限制返回的资源。有效参数是

description：QoS 策略的描述。
is_shared：策略是否在项目之间共享。
name：QoS 策略的名称。
project_id：拥有网络的项目的 ID。

返回值:

QoS 策略对象的生成器

返回类型:

QoSPolicy

update_qos_policy(qos_policy, **attrs)

更新 QoS 策略

参数：

qos_policy – 可以是 QoS 策略的 ID，也可以是 QoSPolicy 实例。
attrs – 要更新由 qos_policy 表示的 QoS 策略的属性。

返回值:

更新后的 QoS 策略

返回类型:

QoSPolicy

find_qos_rule_type(rule_type_name, ignore_missing=True)

查找单个 QoS 规则类型详情

参数：

rule_type_name – QoS 规则类型的名称。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 QoSRuleType 或 None

get_qos_rule_type(qos_rule_type)

获取单个 QoS 规则类型的详细信息

参数：: qos_rule_type – 该值可以是 QoS 策略规则类型的名称，或者是一个 QoSRuleType 实例。
返回值:: 一个 QoSRuleType
引发:: NotFoundException，当找不到资源时。

qos_rule_types(**query)

返回 QoS 规则类型的生成器

参数：

query (dict) –

可选的查询参数，用于限制返回的资源。有效的参数包括

type：QoS 规则类型的类型。

返回值:

QoS 规则类型对象的生成器

返回类型:

QoSRuleType

Agent 操作¶

agents(**query)

返回网络 Agent 的生成器

参数：

query (dict) –

可选查询参数，用于限制返回的资源。

agent_type：Agent 类型。
availability_zone：Agent 的可用区。
binary：Agent 的应用程序二进制文件的名称。
description：Agent 的描述。
host：Agent 运行的主机（主机名或主机地址）。
topic：使用的消息队列主题。
is_admin_state_up：Agent 的管理状态。
is_alive：Agent 是否存活。

返回值:

Agent 的生成器

返回类型:

delete_agent(agent, ignore_missing=True)

删除网络 Agent

参数：

agent – 该值可以是 Agent 的 ID，或者是一个 Agent 实例。
ignore_missing (bool) – 如果设置为 False，当 Agent 不存在时，将引发 NotFoundException。如果设置为 True，则在尝试删除不存在的 Agent 时不会设置任何异常。

返回值:

无

get_agent(agent)

获取单个网络 Agent

参数：: agent – 该值可以是 Agent 的 ID，或者是一个 Agent 实例。
返回值:: 一个 Agent
返回类型:: 代理
引发:: NotFoundException，当找不到资源时。

update_agent(agent, **attrs)

更新网络 Agent

参数：

agent – 该值可以是 Agent 的 ID，或者是一个 Agent 实例。
attrs – 要更新 Agent 属性，由 value 表示。

返回值:

一个 Agent

返回类型:

network_hosting_dhcp_agents(network, **query)

托管在网络上的 DHCP Agent 的生成器。

参数：

network – Network 的实例
query (dict) – 可选的查询参数，用于限制返回的资源。

返回值:

托管 DHCP Agent 的生成器

routers_hosting_l3_agents(router, **query)

返回托管路由器的 L3 Agent 的生成器

参数：

router – 路由器 ID 或 Router 的实例
query (kwargs) – 可选的查询参数，用于限制返回的资源

返回值:

Router L3 Agent 的生成器

返回类型:

RouterL3Agents

agent_hosted_routers(agent, **query)

返回由 L3 Agent 托管的路由器的生成器

参数：

agent – 要么是 Agent 的实例的代理 ID
query (kwargs) – 可选的查询参数，用于限制返回的资源

返回值:

路由器的生成器

返回类型:

L3AgentRouters

add_router_to_agent(agent, router)

将路由器添加到 L3 Agent

参数：

agent – Agent 的 ID 或 Agent 实例
router – 路由器实例

返回值:

带有附加路由器的 Agent

返回类型:

remove_router_from_agent(agent, router)

从 L3 Agent 中删除路由器

参数：

agent – Agent 的 ID 或 Agent 实例
router – 路由器实例

返回值:

带有删除路由器的 Agent

返回类型: