Placement API

Placement 类

Placement 的高级接口可通过 Connection 对象的 placement 成员访问。只有检测到服务时,才会添加 placement 成员。

资源类

class openstack.placement.v1._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_resource_class(**attrs)

创建具有属性的新资源类。

参数:

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

返回值:

资源类创建的结果

返回类型:

ResourceClass

delete_resource_class(resource_class, ignore_missing=True)

删除资源类

参数:
  • resource_class – 该值可以是资源类的 ID 或 ResourceClass 实例。

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

返回值:

update_resource_class(resource_class, **attrs)

更新资源类

参数:
  • resource_class – 该值可以是资源类的 ID 或 ResourceClass 实例。

  • attrs – 要更新由 resource_class 表示的资源类上的属性。

返回值:

更新后的资源类

返回类型:

ResourceClass

get_resource_class(resource_class)

获取单个 resource_class。

参数:

resource_class – 该值可以是资源类的 ID 或 ResourceClass 实例。

返回值:

一个 ResourceClass 实例

引发:

NotFoundException,当找不到匹配条件的资源类时。

resource_classes(**query)

检索资源类生成器。

参数:

query (kwargs) – 可选的查询参数,用于发送以限制返回的资源类。

返回值:

资源类实例的生成器。

资源提供者

class openstack.placement.v1._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_resource_provider(**attrs)

从属性创建新的资源提供者。

参数:

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

返回值:

资源提供者创建的结果

返回类型:

ResourceProvider

delete_resource_provider(resource_provider, ignore_missing=True)

删除资源提供程序

参数:
  • resource_provider – 该值可以是资源提供者的 ID 或 ResourceProvider 实例。

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

返回值:

update_resource_provider(resource_provider, **attrs)

更新资源提供者

参数:
  • resource_provider – 该值可以是资源提供者的 ID 或 ResourceProvider 实例。

  • attrs – 要更新由 resource_provider 表示的资源提供者上的属性。

返回值:

更新后的资源提供者

返回类型:

ResourceProvider

get_resource_provider(resource_provider)

获取单个 resource_provider。

参数:

resource_provider – 该值可以是资源提供者的 ID 或 ResourceProvider 实例。

返回值:

一个 ResourceProvider 实例

引发:

NotFoundException,当找不到匹配条件的资源提供者时。

find_resource_provider(name_or_id, ignore_missing=True)

查找单个 resource_provider。

参数:
  • name_or_id – 资源提供者的名称或 ID。

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

返回值:

一个 ResourceProvider 实例

引发:

NotFoundException,当找不到匹配条件的资源提供者时。

resource_providers(**query)

检索资源提供者生成器。

参数:

query (kwargs) – 可选的查询参数,用于发送以限制返回的资源提供者。

返回值:

资源提供者实例的生成器。

get_resource_provider_aggregates(resource_provider)

获取资源提供者的聚合列表。

参数:

resource_provider – 该值可以是资源提供者的 ID 或 ResourceProvider 实例。

返回值:

一个 ResourceProvider 实例,其中填充了 aggregates 属性。

引发:

NotFoundException,当找不到匹配条件的资源提供者时。

set_resource_provider_aggregates(resource_provider, *aggregates)

更新资源提供者的聚合。

参数:
  • resource_provider – 该值可以是资源提供者的 ID 或 ResourceProvider 实例。

  • aggregates – 聚合列表。这些聚合将替换当前存在的所有聚合。

返回值:

一个 ResourceProvider 实例,其中填充了更新后的 aggregates 属性。

引发:

NotFoundException,当找不到匹配条件的资源提供者时。

资源提供者库存

class openstack.placement.v1._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_resource_provider_inventory(resource_provider, resource_class, *, total, **attrs)

从属性创建新的资源提供者库存

参数:
  • resource_provider – 资源提供者的 ID 或 ResourceProvider 实例。

  • total – 提供者可以容纳的资源的实际数量。

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

返回值:

资源提供者库存创建的结果

返回类型:

ResourceProviderInventory

delete_resource_provider_inventory(resource_provider_inventory, resource_provider=None, ignore_missing=True)

删除资源提供者库存

参数:
  • resource_provider_inventory – 该值可以是资源提供者的 ID 或 ResourceProviderInventory 实例。

  • resource_provider – 资源提供者的 ID 或 ResourceProvider 实例。当 resource_provider_inventory 是 ID 时,必须指定此值。

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

返回值:

update_resource_provider_inventory(resource_provider_inventory, resource_provider=None, *, resource_provider_generation=None, **attrs)

更新资源提供者的库存

参数:
  • resource_provider_inventory – 该值可以是资源提供者库存的 ID,也可以是 ResourceProviderInventory 实例。

  • resource_provider – 资源提供者的 ID 或 ResourceProvider 实例。当 resource_provider_inventory 是 ID 时,必须指定此值。

Attrs kwargs:

要更新由 resource_provider_inventory 表示的资源提供者库存的属性。

返回值:

更新后的资源提供者库存

返回类型:

ResourceProviderInventory

get_resource_provider_inventory(resource_provider_inventory, resource_provider=None)

获取单个 resource_provider_inventory

参数:
  • resource_provider_inventory – 该值可以是资源提供者库存的 ID,也可以是 ResourceProviderInventory 实例。

  • resource_provider – 资源提供者的 ID 或 ResourceProvider 实例。当 resource_provider_inventory 是 ID 时,必须指定此值。

返回值:

一个 ResourceProviderInventory 实例

引发:

NotFoundException,当没有匹配标准的资源提供者库存时。

resource_provider_inventories(resource_provider, **query)

检索资源提供者库存的生成器

参数:
  • resource_provider – 资源提供者的 ID 或 ResourceProvider 实例。

  • query – 可选的查询参数,用于发送到服务器以限制返回的资源。

返回值:

资源提供者库存实例的生成器。

Traits

class openstack.placement.v1._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_trait(name)

创建一个新的 trait

参数:

name – 新 trait 的名称

返回值:

trait 创建的结果

返回类型:

Trait

delete_trait(trait, ignore_missing=True)

删除一个 trait

参数:
  • trait – 该值可以是 trait 的 ID,也可以是 Trait 实例。

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

返回值:

get_trait(trait)

获取单个 trait

参数:

trait – 该值可以是 trait 的 ID,也可以是 Trait 实例。

返回值:

一个 ResourceProviderInventory 实例

引发:

NotFoundException,当没有匹配标准的 trait 时。

traits(**query)

检索 traits 的生成器

参数:

query – 可选的查询参数,用于发送到服务器以限制返回的资源。

返回值:

trait 对象的生成器