Cluster API¶

Cluster 类¶

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

构建信息操作¶

class openstack.clustering.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)

get_build_info()

获取服务引擎和 API 的构建信息

返回值:: 一个包含 API 和引擎修订字符串的字典。

配置类型操作¶

profile_types(**query)

获取配置类型生成器。

返回值:: 一个生成器，生成类型为 ProfileType 的对象。

get_profile_type(profile_type)

获取配置类型的详细信息。

参数：: profile_type – 配置类型的名称或 ProfileType 对象。
返回值:: 一个 ProfileType 对象。
引发:: NotFoundException，当找不到匹配名称的配置类型时。

配置操作¶

create_profile(**attrs)

从属性创建新的配置。

参数：: attrs (dict) – 关键字参数，将用于创建 Profile，它包含 Profile 类上的属性。
返回值:: 配置创建的结果。
返回类型:: 简介.

delete_profile(profile, ignore_missing=True)

删除配置。

参数：

profile – 该值可以是配置的名称或 ID，也可以是 Profile 实例。
ignore_missing (bool) – 当设置为 False 时，如果在找不到配置时将引发异常 NotFoundException。当设置为 True 时，在尝试删除不存在的配置时不会引发异常。

返回值:

无

find_profile(name_or_id, ignore_missing=True)

查找单个配置。

参数：

name_or_id (str) – 配置的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 Profile 对象或 None

get_profile(profile)

获取单个配置。

参数：: profile – 该值可以是配置的名称或 ID，也可以是 Profile 实例。
返回值:: 一个 Profile
引发:: NotFoundException，当找不到匹配条件的配置时。

profiles(**query)

检索配置生成器。

参数：

query (kwargs) –

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

name：配置的名称。
type：配置的类型名称。
metadata：与配置关联的键值对列表。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
limit：请求查询返回的指定大小的项目。返回最多指定限制值数量的项目。
marker：指定上次看到项目的 ID。使用 limit 参数进行初始的有限请求，并在后续的有限请求中使用响应中上次看到项目的 ID 作为 marker 参数值。
global_project：一个布尔值，指示是否将返回所有项目的配置。

返回值:

配置实例生成器。

update_profile(profile, **attrs)

更新配置。

参数：

profile – 配置的名称或 ID，或者 Profile 的实例。
attrs – 要更新配置的属性，由 value 参数表示。

返回值:

更新后的配置。

返回类型:

简介

validate_profile(**attrs)

验证配置规范。

参数：: attrs (dict) – 关键字参数，将用于创建 ProfileValidate，它包含 Profile 类上的属性。
返回值:: 配置验证的结果。
返回类型:: ProfileValidate.

策略类型操作¶

policy_types(**query)

获取策略类型生成器。

返回值:: 一个生成器，生成类型为 PolicyType 的对象。

get_policy_type(policy_type)

获取策略类型的详细信息。

参数：: policy_type – 策略类型的名称或 PolicyType 对象。
返回值:: 一个 PolicyType 对象。
引发:: NotFoundException，当找不到匹配名称的策略类型时。

策略操作¶

create_policy(**attrs)

从属性创建新的策略。

参数：: attrs (dict) – 关键字参数，将用于创建 Policy，它包含 Policy 类上的属性。
返回值:: 策略创建的结果。
返回类型:: 策略.

delete_policy(policy, ignore_missing=True)

删除策略。

参数：

policy – 该值可以是策略的名称或 ID，也可以是 Policy 实例。
ignore_missing (bool) – 如果设置为 False，当找不到策略时将引发异常 NotFoundException。如果设置为 True，尝试删除不存在的策略时将不会引发异常。

返回值:

无

find_policy(name_or_id, ignore_missing=True)

查找单个策略。

参数：

name_or_id (str) – 策略的名称或 ID。
ignore_missing (bool) – 如果设置为 False，当指定的策略不存在时将引发异常 NotFoundException。如果设置为 True，尝试查找不存在的策略时将返回 None。

返回值:

策略对象或 None。

返回类型:

策略

get_policy(policy)

获取单个策略。

参数：: policy – 该值可以是策略的名称或 ID，也可以是 Policy 实例。
返回值:: 策略对象。
返回类型:: 策略
引发:: 当找不到符合条件的策略时，将引发 NotFoundException。

policies(**query)

检索策略生成器。

参数：

query (kwargs) –

可选查询参数，用于限制要返回的策略。可用的参数包括

name: 策略的名称。
type: 策略的类型名称。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
limit：请求查询返回的指定大小的项目。返回最多指定限制值数量的项目。
marker：指定上次看到项目的 ID。使用 limit 参数进行初始的有限请求，并在后续的有限请求中使用响应中上次看到项目的 ID 作为 marker 参数值。
global_project: 一个布尔值，指示是否返回所有项目的策略。

返回值:

策略实例生成器。

update_policy(policy, **attrs)

更新策略。

参数：

policy – 策略的名称或 ID，或者 Policy 的实例。
attrs – 要更新策略的属性，由 value 参数表示。

返回值:

更新后的策略。

返回类型:

策略

validate_policy

集群操作¶

create_cluster(**attrs)

从属性创建新集群。

参数：: attrs (dict) – 关键字参数，将用于创建 Cluster，它包含 Cluster 类上的属性。
返回值:: 集群创建的结果。
返回类型:: 集群.

delete_cluster(cluster, ignore_missing=True, force_delete=False)

删除集群。

参数：

cluster – 该值可以是集群的名称或 ID，也可以是 Cluster 实例。
ignore_missing (bool) – 如果设置为 False，当找不到集群时将引发异常 NotFoundException。如果设置为 True，尝试删除不存在的集群时将不会引发异常。
force_delete (bool) – 如果设置为 True，将立即强制删除集群。

返回值:

被删除的 Cluster 实例。

返回类型:

集群.

find_cluster(name_or_id, ignore_missing=True)

查找单个集群。

参数：

name_or_id (str) – 集群的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 Cluster 对象或 None

get_cluster(cluster)

获取单个集群。

参数：: cluster – 该值可以是集群的名称或 ID，也可以是 Cluster 实例。
返回值:: 一个 Cluster
引发:: 当找不到符合条件的集群时，将引发 NotFoundException。

clusters(**query)

检索集群生成器。

参数：

query (kwargs) –

可选查询参数，用于限制要返回的集群。可用的参数包括

name: 集群的名称。
status: 集群的当前状态。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
limit：请求查询返回的指定大小的项目。返回最多指定限制值数量的项目。
marker：指定上次看到项目的 ID。使用 limit 参数进行初始的有限请求，并在后续的有限请求中使用响应中上次看到项目的 ID 作为 marker 参数值。
global_project: 一个布尔值，指示是否返回所有项目的集群。

返回值:

集群实例生成器。

update_cluster(cluster, **attrs)

更新集群。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
attrs – 要更新集群的属性，由 cluster 参数表示。

返回值:

更新后的集群。

返回类型:

集群

add_nodes_to_cluster(cluster, nodes)

将节点添加到集群。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
nodes – 要添加到集群的节点列表。

返回值:

包含此操作启动的动作的字典。

remove_nodes_from_cluster(cluster, nodes, **params)

从集群中删除节点。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
nodes – 要从集群中删除的节点列表。
params (kwargs) –
可选查询参数，用于限制要返回的节点。可用的参数包括
- destroy_after_deletion: 一个布尔值，指示是否立即销毁删除的节点。

返回值:

包含此操作启动的动作的字典。

replace_nodes_in_cluster(cluster, nodes)

使用指定的节点替换集群中的节点。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
nodes – 要删除/添加到集群的节点列表。

返回值:

包含此操作启动的动作的字典。

scale_out_cluster(cluster, count=None)

增加集群的大小。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
count – 可选参数，指定要添加的节点数。

返回值:

包含此操作启动的动作的字典。

scale_in_cluster(cluster, count=None)

缩小集群的大小。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
count – 可选参数，指定要删除的节点数。

返回值:

包含此操作启动的动作的字典。

resize_cluster(cluster, **params)

集群调整大小。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
params (dict) – 提供调整大小操作参数的字典。

返回值:

包含此操作启动的动作的字典。

attach_policy_to_cluster(cluster, policy, **params)

将策略附加到集群。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
policy – 策略的名称或 ID。
params (dict) – 包含要附加的策略属性的字典。

返回值:

包含此操作启动的动作的字典。

detach_policy_from_cluster(cluster, policy)

将策略从集群中分离。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
policy – 策略的名称或 ID。

返回值:

包含此操作启动的动作的字典。

update_cluster_policy(cluster, policy, **params)

更改绑定到集群的策略的属性。

参数：

cluster – 集群的名称或 ID，或者 Cluster 的实例。
policy – 策略的名称或 ID。
params (dict) – 包含策略的新属性的字典。

返回值:

包含此操作启动的动作的字典。

collect_cluster_attrs(cluster, path, **query)

收集集群中的属性值。

参数：

cluster – 该值可以是集群的 ID，也可以是 Cluster 实例。
path – 指定要收集的属性的 Json 路径字符串。
query – 可选的查询参数，用于发送到服务器以限制返回的资源。

返回值:

包含属性值列表的字典。

check_cluster(cluster, **params)

检查集群。

参数：

cluster – 该值可以是集群的 ID，也可以是 Cluster 实例。
params (dict) – 提供检查操作参数的字典。

返回值:

包含动作 ID 的字典。

recover_cluster(cluster, **params)

恢复集群。

参数：

cluster – 该值可以是集群的 ID，也可以是 Cluster 实例。
params (dict) – 提供恢复操作参数的字典。

返回值:

包含动作 ID 的字典。

perform_operation_on_cluster(cluster, operation, **params)

对指定的集群执行操作。

参数：

cluster – 该值可以是集群的 ID，也可以是 Cluster 实例。
operation – 指定要执行的操作的字符串。
params (dict) – 提供操作参数的字典。

返回值:

包含动作 ID 的字典。

cluster_policies(cluster, **query)

检索集群-策略绑定生成器。

参数：

cluster – 该值可以是集群的名称或 ID，也可以是 Cluster 实例。
query (kwargs) –
可选查询参数，用于限制要返回的策略。可用的参数包括
- enabled: 一个布尔值，指示策略是否在集群上启用。

返回值:

集群-策略绑定实例生成器。

get_cluster_policy(cluster_policy, cluster)

获取集群-策略绑定。

参数：

cluster_policy – 该值可以是策略的名称或 ID，也可以是 Policy 实例。
cluster – 该值可以是集群的名称或 ID，也可以是 Cluster 实例。

返回值:

一个集群策略绑定对象。

返回类型:

CLusterPolicy

引发:

NotFoundException 当没有匹配标准的集群策略绑定时。

节点操作¶

create_node(**attrs)

从属性创建新节点。

参数：: attrs (dict) – 关键字参数，用于创建 Node，它包含 Node 类上的属性。
返回值:: 节点创建的结果。
返回类型:: Node.

delete_node(node, ignore_missing=True, force_delete=False)

删除一个节点。

参数：

node – 该值可以是节点的名称或 ID，也可以是 Node 实例。
ignore_missing (bool) – 当设置为 False 时，如果找不到节点，将引发异常 NotFoundException。当设置为 True 时，尝试删除不存在的节点不会引发任何异常。
force_delete (bool) – 当设置为 True 时，将立即强制删除节点。

返回值:

被删除的 Node 实例。

返回类型:

Node.

find_node(name_or_id, ignore_missing=True)

查找单个节点。

参数：

name_or_id (str) – 节点的名称或 ID。
ignore_missing (bool) – 当设置为“False”时，如果指定的节点不存在，将引发 NotFoundException。当设置为“True”时，尝试查找不存在的策略将返回 None。

返回值:

一个 Node 对象或 None。

get_node(node, details=False)

获取单个节点。

参数：

node – 该值可以是节点的名称或 ID，也可以是 Node 实例。
details – 一个可选参数，指示在检索节点数据时服务器是否应返回更多详细信息。

返回值:

一个 Node。

引发:

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

nodes(**query)

检索节点生成器。

参数：

query (kwargs) –

可选查询参数，用于限制要返回的节点。可用的参数包括

cluster_id: 一个字符串，包含结果节点是成员的集群的名称或 ID。
name: 节点的名称。
status: 节点的当前状态。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
limit: 请求从查询返回的最大项目数。
marker: 指定上次看到的节点的 ID。使用 limit 参数进行初始有限请求，并将响应中上次看到的节点的 ID 作为 marker 参数值用于后续有限请求。
global_project: 一个布尔值，指示是否返回所有项目的节点。

返回值:

节点实例的生成器。

update_node(node, **attrs)

更新一个节点。

参数：

node – 节点的名称或 ID，或者 Node 的实例。
attrs – 要更新到由 node 参数表示的节点上的属性。

返回值:

更新的节点。

返回类型:

Node

check_node(node, **params)

检查指定节点的健康状况。

参数：

node – 该值可以是节点的 ID，也可以是 Node 实例。
params (dict) – 提供给 check 操作的参数的字典。

返回值:

包含动作 ID 的字典。

recover_node(node, **params)

将指定的节点恢复为健康状态。

参数：

node – 该值可以是节点的 ID，也可以是 Node 实例。
params (dict) – 提供给 recover 操作的参数的字典。

返回值:

包含动作 ID 的字典。

adopt_node(preview=False, **attrs)

将现有资源作为节点采用。

参数：

preview – 一个布尔值，指示这是否是一个“预览”操作，这意味着仅返回要使用的配置文件，而不是使用该配置文件创建节点对象。
attrs (dict) –
节点采用的关键字参数。有效参数包括
- type: (必需) 一个字符串，包含要用于节点采用的配置文件类型和版本。例如，os.nova.sever-1.0。
- identity: (必需) 一个字符串，包含要作为 Senlin 节点采用的 OpenStack 资源的名称或 ID。
- name: (可选) 要创建的节点的名称。省略此参数将使节点自动命名。
- snapshot: (可选) 一个布尔值，指示是否应在可能的情况下创建目标资源的快照。默认值为 False。
- metadata: (可选) 一个任意键值对的字典，与采用的节点相关联。
- overrides: (可选) 一个键值对的字典，用于覆盖从目标资源派生的属性。

返回值:

节点采用的结果。如果 preview 设置为 False（默认值），则返回一个 Node 对象，否则返回一个包含用于新节点的配置文件的 Dict。

perform_operation_on_node(node, operation, **params)

对指定的节点执行操作。

参数：

node – 该值可以是节点的 ID，也可以是 Node 实例。
operation – 指定要执行的操作的字符串。
params (dict) – 提供操作参数的字典。

返回值:

包含动作 ID 的字典。

接收器操作¶

create_receiver(**attrs)

从属性创建新的接收器。

参数：: attrs (dict) – 关键字参数，用于创建 Receiver，它包含 Receiver 类上的属性。
返回值:: 接收器创建的结果。
返回类型:: 接收器.

update_receiver(receiver, **attrs)

更新一个接收器。

参数：

receiver – 该值可以是接收器的名称或 ID，也可以是 Receiver 实例。
attrs – 要更新到 receiver 参数上的属性。有效的属性名称包括 name、action 和 params。

返回值:

更新的接收器。

返回类型:

接收器

delete_receiver(receiver, ignore_missing=True)

删除一个接收器。

参数：

receiver – 该值可以是接收器的名称或 ID，也可以是 Receiver 实例。
ignore_missing (bool) – 当设置为 False 时，如果找不到接收器，将引发异常 NotFoundException。当设置为 True 时，尝试删除不存在的接收器不会引发任何异常。

返回值:

无

find_receiver(name_or_id, ignore_missing=True)

查找单个接收器。

参数：

name_or_id (str) – 接收器的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果指定的接收器不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的接收器将返回 None。

返回值:

一个接收器对象或 None。

返回类型:

接收器

get_receiver(receiver)

获取单个接收器。

参数：: receiver – 该值可以是接收器的名称或 ID，也可以是 Receiver 实例。
返回值:: 一个接收器对象。
返回类型:: 接收器
引发:: NotFoundException 当找不到匹配标准的接收器时。

receivers(**query)

检索接收器生成器。

参数：

query (kwargs) –

可选查询参数，用于限制要返回的接收器。可用的参数包括

name: 接收器对象的名称。
type: 接收器对象的类型。
cluster_id: 关联集群的 ID。
action: 关联操作的名称。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
global_project: 一个布尔值，指示是否返回
来自所有项目的接收器。

返回值:

接收器实例的生成器。

操作操作¶

get_action(action)

获取单个操作。

参数：: action – 该值可以是操作的名称或 ID，或者是一个 Action 实例。
返回值:: 一个操作对象。
返回类型:: 行动
引发:: NotFoundException 当没有匹配标准的动作时引发。

actions(**query)

检索操作的生成器。

参数：

query (kwargs) –

可选的查询参数，用于限制要返回的操作。可用的参数包括

name: 操作名称用于查询。
target: 目标对象的 ID，用于返回操作。
action: 用于查询的内置操作类型。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
limit：请求查询返回的指定大小的项目。返回最多指定限制值数量的项目。
marker：指定上次看到项目的 ID。使用 limit 参数进行初始的有限请求，并在后续的有限请求中使用响应中上次看到项目的 ID 作为 marker 参数值。

返回值:

操作实例的生成器。

事件操作¶

get_event(event)

获取单个事件。

参数：: event – 该值可以是事件的名称或 ID，或者是一个 Event 实例。
返回值:: 一个事件对象。
返回类型:: Event
引发:: NotFoundException 当没有匹配标准的事件时引发。

events(**query)

检索事件的生成器。

参数：

query (kwargs) –

可选的查询参数，用于限制要返回的事件。可用的参数包括

obj_name: 与事件关联的对象的名称字符串。
obj_type: 与事件相关的对象的类型字符串。该值可以是 cluster、node、policy 等。
obj_id: 与事件关联的对象的 ID。
cluster_id: 与事件关联的集群的 ID（如果有）。
action: 与事件关联的操作名称。
sort：用逗号分隔的排序键列表。每个排序键可以选择性地附加排序方向修饰符，可以是 asc 或 desc。
limit：请求查询返回的指定大小的项目。返回最多指定限制值数量的项目。
marker：指定上次看到项目的 ID。使用 limit 参数进行初始的有限请求，并在后续的有限请求中使用响应中上次看到项目的 ID 作为 marker 参数值。
global_project: 一个布尔值，指定是否应返回所有项目的事件。此选项受访问控制检查约束。

返回值:

事件实例的生成器。

辅助操作¶

wait_for_status(res, status, failures=None, interval=2, wait=None, attribute='status', callback=None)

等待资源达到特定状态。

参数：

session – 用于进行此请求的会话。
resource – 要等待达到状态的资源。资源必须通过 attribute 指定状态属性。
status – 期望的资源状态。
failures – 将指示转换失败的状态，例如 ‘ERROR’。默认为 [‘ERROR’]。
interval – 两次检查之间的秒数。
wait – 等待转换的最大秒数。设置为 None 以无限期等待。
attribute – 包含状态的资源属性的名称。
callback – 回调函数。将使用单个值（进度）调用此函数。此函数特定于 API，但通常是从 0-100 的百分比值。

返回值:

更新后的资源。

引发:

ResourceTimeout 如果在 wait 秒内未能转换为状态。

引发:

ResourceFailure 如果资源转换为 failures 中的状态之一。

引发:

AttributeError 如果资源没有 status 属性

wait_for_delete(res, interval=2, wait=120, callback=None)

等待资源被删除。

参数：

res – 要等待被删除的资源。
interval – 两次连续检查之间的秒数。
wait – 在更改之前等待的最大秒数。
callback – 回调函数。将使用单个值（进度）调用此函数，该值是从 0-100 的百分比值。

返回值:

成功时返回资源。

引发:

ResourceTimeout 如果在指定秒数内未能转换为删除状态。

服务操作¶

services(**query)

获取服务的生成器。

返回值:: 类型为 Service 的对象的生成器

Cluster API

Cluster API¶

Cluster 类¶

构建信息操作¶

配置类型操作¶

配置操作¶

策略类型操作¶

策略操作¶

集群操作¶

节点操作¶

接收器操作¶

操作操作¶

事件操作¶

辅助操作¶

服务操作¶

openstacksdk 4.7.2.dev3

页面内容