Baremetal Introspection API

Baremetal Introspection Proxy

Baremetal introspection 的高级接口通过 Connection 对象中的 baremetal_introspection 成员提供。只有检测到该服务时，才会添加 baremetal_introspection 成员。

Introspection Process Operations

class openstack.baremetal_introspection.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)
introspections(**query)

检索 introspection 记录的生成器。

参数：

query (dict) –

可选的查询参数，用于限制返回的记录。可用的参数包括

  • fields：一个列表，包含要返回响应中的一个或多个字段。这可能会带来一些性能提升，因为资源的其它字段不会被刷新。

  • limit：请求从查询返回的最大项目数。

  • marker：指定上次看到的 introspection 的 ID。使用 limit 参数进行初始的有限请求，并将响应中上次看到的 introspection 的 ID 作为 marker 值在后续的有限请求中使用。

  • sort_dir：按请求的排序方向对响应进行排序。有效值为 asc（升序）或 desc（降序）。默认值为 asc。您可以指定多个排序键和排序方向查询参数。如果您在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

  • sort_key：按此属性值对响应进行排序。默认值为 id。您可以指定多个排序键和排序方向查询参数。如果您在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

返回值:

一个 Introspection 对象的生成器

start_introspection(node, manage_boot=None)

从属性创建新的 introspection。

参数：

  • node – 该值可以是节点名称或 ID，也可以是 Node 实例。

  • manage_boot (bool) – 是否管理节点的启动参数。默认为服务器默认值（为 True）。

返回值:

Introspection 实例。

get_introspection(introspection)

获取特定的 introspection。

参数：

introspection – 该值可以是 introspection 的名称或 ID（与 bare metal 节点名称或 ID 匹配），也可以是 Introspection 实例。

返回值:

Introspection 实例。

引发:

NotFoundException 当找不到匹配名称或 ID 的 introspection 时。

get_introspection_data(introspection, processed=True)

获取 introspection 数据。

参数：

  • introspection – 该值可以是 introspection 的名称或 ID（与 bare metal 节点名称或 ID 匹配），也可以是 Introspection 实例。

  • processed – 是否获取最终处理后的数据（默认）或从 ramdisk 接收到的原始未处理数据。

返回值:

来自最近一次成功运行的 introspection 数据。

返回类型:

dict

abort_introspection(introspection, ignore_missing=True)

中止一个 introspection。

请注意，introspection 并非立即中止，您可以使用 wait_for_introspection 并设置 ignore_error=True。

参数：

  • introspection – 该值可以是 introspection 的名称或 ID（与 bare metal 节点名称或 ID 匹配），也可以是 Introspection 实例。

  • ignore_missing (bool) – 当设置为 False 时，如果找不到 introspection，将引发异常 NotFoundException。当设置为 True 时，尝试中止不存在的 introspection 时不会引发任何异常。

返回值:

无

wait_for_introspection(introspection, timeout=None, ignore_error=False)

等待 introspection 完成。

参数：

  • introspection – 该值可以是 introspection 的名称或 ID（与 bare metal 节点名称或 ID 匹配），也可以是 Introspection 实例。

  • timeout – 等待 introspection 的时间（以秒为单位）。None（默认值）表示客户端没有超时。

  • ignore_error – 如果为 True，则如果 introspection 达到 error 状态，此调用将引发异常。否则，error 状态被视为成功，并且调用返回。

返回值:

Introspection 实例。

引发:

ResourceFailure 如果 introspection 失败且 ignore_error 为 False。

引发:

ResourceTimeout 超时时。