共享文件系统 API

共享文件系统类

访问共享文件系统服务 API 的高级接口可通过 Connection 对象的 shared_file_system 成员获得。只有在检测到服务时才会添加 shared_file_system 成员。share 是 shared_file_system 成员的别名。

共享文件系统可用区

与共享文件系统服务支持的可用区进行交互。

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

availability_zones()

检索共享文件系统可用区

返回值:

可用区资源的生成器

返回类型:

AvailabilityZone

共享文件系统共享

与共享文件系统服务支持的共享进行交互。

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

shares(details=True, **query)

列出所有共享及其详细信息

参数：

query (kwargs) –

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

• status: 按共享状态过滤

• share_server_id: 共享服务器的 UUID。

• metadata: 一个或多个元数据键值对，格式为 URL 编码的字符串字典。

• extra_specs: 额外的规范，作为一组一个或多个键值对。

• share_type_id: 用于查询资源的共享类型的 UUID。

• name: 用于过滤资源的资源的用户定义名称。

• snapshot_id: 共享的基础快照的 UUID，用于基于此过滤请求。

• host: 用于查询的资源的主机名。

• share_network_id: 用于过滤资源的共享网络的 UUID。

• project_id: 拥有资源的项目的 ID。

• is_public: 一个布尔查询参数，当设置为 true 时，允许检索属于所有项目的公共资源。

• share_group_id: 用于过滤资源的共享组的 UUID。

• export_location_id: 可用于过滤共享或共享实例的导出位置 UUID。

• export_location_path: 可用于过滤共享或共享实例的导出位置路径。

• name~: 可用于过滤共享、共享快照、共享网络或共享组的名称模式。

• description~: 可用于过滤共享、共享快照、共享网络或共享组的描述模式。

• with_count: 是否在 API 响应中显示计数，默认为 False。

• limit: 返回的最大共享数量。

• offset: 定义共享或共享组列表起始点的偏移量。

• sort_key: 共享列表的排序键。

• sort_dir: 共享列表的排序方向。有效值为 asc 或 desc。

返回值:

共享资源的详细信息

返回类型:

分享

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

查找单个共享

参数：

• name_or_id – 共享的名称或 ID。

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

• query (dict) – 要传递给底层方法的任何附加参数，例如查询过滤器。

返回值:

一个 Share 或 None

get_share(share_id)

列出单个共享的详细信息

参数：

share – 要获取的共享的 ID

返回值:

已识别共享的详细信息

返回类型:

分享

delete_share(share, ignore_missing=True)

删除单个共享

参数：

share – 要删除的共享的 ID

返回值:

delete 的结果

返回类型:

无

update_share(share_id, **attrs)

更新单个共享的详细信息。

参数：

• share – 要更新的共享的 ID

• attrs (dict) – 要在共享上更新的属性

返回值:

更新后的共享

返回类型:

分享

create_share(**attrs)

从属性创建共享

返回值:

新共享的详细信息

参数：

attrs (dict) – 将用于创建 Shares 的属性，包括 Shares 类上的属性。创建共享需要 'size' 和 'share'。

返回类型:

分享

revert_share_to_snapshot(share_id, snapshot_id)

将共享恢复到指定的快照，该快照必须是

manila 已知的最新快照。

参数：

• share_id – 要恢复的共享的 ID

• snapshot_id – 要恢复到的快照的 ID

返回值:

revert 的结果

返回类型:

无

manage_share(protocol, export_path, service_host, **params)

管理共享。

参数：

• protocol (str) – 此共享的共享文件系统协议。

• export_path (str) – 根据协议格式化的导出路径。

• service_host (str) – manage-share 服务主机。

• params (kwargs) – 要发送的可选参数。可用参数包括： * name: 资源的用户定义名称。 * share_type: 用于创建资源的共享类型的名称或 ID。 * driver_options: 一组一个或多个键值对，作为字符串字典，描述驱动程序选项。 * is_public: 共享的可见性级别。 * description: 资源的用户定义描述。 * share_server_id: 共享服务器的 UUID。

返回值:

已管理的共享。

unmanage_share(share_id)

取消管理给定共享 ID 的共享。

参数：

share_id – 要取消管理的共享的 ID。

返回值:

无

resize_share(share_id, new_size, no_shrink=False, no_extend=False, force=False)

调整共享大小，根据需要扩展/收缩共享。

参数：

• share_id – 要调整大小的共享的 ID

• new_size – 共享的新大小，单位为 GiB。如果 new_size 与当前大小相同，则不执行任何操作。

• no_shrink (bool) – 如果设置为 True，则不收缩给定共享，即使为了使共享达到给定大小需要收缩共享。这对于将共享扩展到最小大小，同时不将共享收缩到给定大小可能很有用。默认为 False。

• no_extend (bool) – 如果设置为 True，则不扩展给定共享，即使为了使共享达到给定大小需要扩展共享。这对于将共享收缩到最大大小，同时不将较小的共享扩展到该最大大小可能很有用。默认为 False。

• force (bool) – 在需要扩展共享的情况下，是否使用强制。

返回值:

无

共享文件系统存储池

与共享文件系统服务公开的存储池统计信息进行交互。

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

storage_pools(details=True, **query)

列出所有后端存储池及其详细信息

参数：

query (kwargs) –

可选的查询参数，用于限制返回的存储池。可用参数包括

• pool_name: 后端的池名称。

• host_name: 后端的主机名。

• backend_name: 后端的名称。

• capabilities: 存储后端的容量。

• share_type: 共享类型名称或 UUID。

返回值:

manila 存储池资源的生成器

返回类型:

StoragePool

共享文件系统用户消息

查看和操作共享文件系统服务发出的异步用户消息。

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

user_messages(**query)

列出共享文件系统用户消息

参数：

query (kwargs) –

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

• action_id: 创建消息时的操作 ID。

• detail_id: 消息详细信息的 ID。

• limit: 返回的最大共享数量。

• message_level: 消息级别。

• offset: 定义共享或共享组列表起始点的偏移量。

• sort_key: 消息列表的排序键。

• sort_dir: 共享列表的排序方向。

• project_id: 创建消息的项目的 ID。

• request_id: 创建消息时的请求 ID。

• resource_id: 创建消息的资源的 UUID。

• resource_type: 创建消息的资源的类型。

返回值:

用户消息资源的生成器

返回类型:

UserMessage

get_user_message(message_id)

列出单个用户消息的详细信息

参数：

message_id – 用户消息的 ID

返回值:

已识别用户消息的详细信息

返回类型:

UserMessage

delete_user_message(message_id, ignore_missing=True)

删除单个用户消息

参数：

message_id – 用户消息的 ID

返回值:

用户消息“删除”的结果

返回类型:

UserMessage

共享文件系统限制

获取共享文件系统服务支持的资源的绝对限制。

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

limits(**query)

列出所有共享限制。

参数：

query (kwargs) – 要发送的可选查询参数，用于限制返回的共享限制。

返回值:

manila 共享限制资源的生成器

返回类型:

限制

共享文件系统快照

与共享文件系统服务支持的共享快照进行交互。

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

share_snapshots(details=True, **query)

列出所有共享快照及其详细信息。

参数：

query (kwargs) –

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

• project_id: 发出 API 请求的用户或服务的 ID。

返回值:

manila 共享快照资源的生成器

返回类型:

ShareSnapshot

get_share_snapshot(snapshot_id)

列出单个共享快照的详细信息

参数：

snapshot_id – 要获取的快照的 ID

返回值:

已识别共享快照的详细信息

返回类型:

ShareSnapshot

create_share_snapshot(**attrs)

从属性创建共享快照

返回值:

新共享快照的详细信息

返回类型:

ShareSnapshot

update_share_snapshot(snapshot_id, **attrs)

更新单个共享的详细信息。

参数：

snapshot_id – 要更新的快照的 ID

Pram dict attrs:

要在快照上更新的属性

返回值:

更新后的共享快照

返回类型:

ShareSnapshot

delete_share_snapshot(snapshot_id, ignore_missing=True)

删除单个共享快照

参数：

snapshot_id – 要删除的快照的 ID

返回值:

delete 的结果

返回类型:

无

共享文件系统共享快照实例

与共享文件系统服务支持的共享快照实例进行交互。

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

share_snapshot_instances(details=True, **query)

列出所有共享快照实例及其详细信息。

参数：

• details (bool) – 是否获取详细的资源描述。默认为 True。

• query (kwargs) –

  可选的查询参数，用于限制返回的共享快照实例。可用参数包括

  • snapshot_id: 共享的基础快照的 UUID，用于过滤

    基于请求。

  • project_id: 发出请求的用户或服务的项目 ID。

    请求。

返回值:

共享快照实例资源的生成器

返回类型:

ShareSnapshotInstance

get_share_snapshot_instance(snapshot_instance_id)

列出单个共享快照实例的详细信息

参数：

snapshot_instance_id – 要获取的快照实例的 ID

返回值:

已识别快照实例的详细信息

返回类型:

ShareSnapshotInstance

共享文件系统共享网络

使用共享文件系统服务创建和操作共享网络。

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

share_networks(details=True, **query)

列出所有共享网络及其详细信息。

参数：

query (dict) –

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

• name~: 用于过滤资源的资源的用户定义名称。

• project_id: 发出请求的用户或服务的 ID。

• description~: 可用于过滤共享、共享快照、共享网络或共享组的描述模式。

• all_projects: (仅限管理员)。定义是否列出所有项目请求的资源。

返回值:

共享网络的详细信息

返回类型:

ShareNetwork

get_share_network(share_network_id)

列出单个共享网络的详细信息

参数：

share_network – 要获取的共享网络的 ID

返回值:

已识别共享网络的详细信息

返回类型:

ShareNetwork

delete_share_network(share_network_id, ignore_missing=True)

删除单个共享网络

参数：

share_network_id – 要删除的共享网络的 ID

返回类型:

无

update_share_network(share_network_id, **attrs)

更新单个共享网络的详细信息。

参数：

share_network_id – 要更新的共享网络的 ID

Pram dict attrs:

要在共享网络上更新的属性

返回值:

更新后的共享网络

返回类型:

ShareNetwork

create_share_network(**attrs)

从属性创建共享网络

返回值:

新共享网络的详细信息

参数：

attrs (dict) – 将用于创建 ShareNetwork 的属性，包括 ShareNetwork 类上的属性。

返回类型:

ShareNetwork

共享文件系统共享实例

管理员可以在共享文件系统服务中列出、显示信息、显式设置状态和强制删除共享实例。

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

share_instances(**query)

列出所有共享实例。

参数：

query (kwargs) – 要发送的可选查询参数，用于限制返回的共享实例。可用参数包括

• export_location_id: 可用于过滤共享实例的导出位置 UUID。

• export_location_path: 可用于过滤共享实例的导出位置路径。

返回值:

共享实例资源的详细信息

返回类型:

ShareInstance

get_share_instance(share_instance_id)

显示单个共享实例的详细信息

参数：

share_instance_id – 要获取的共享实例的 UUID

返回值:

已识别共享实例的详细信息

返回类型:

ShareInstance

reset_share_instance_status(share_instance_id, status)

显式更新共享实例的状态。

参数：

• share_instance_id – 要重置的共享实例的 UUID。

• status – 要设置的共享或共享实例状态。

返回值:

无

delete_share_instance(share_instance_id)

强制删除共享实例

参数：

share_instance – 要删除的共享实例的 ID

返回值:

无

共享文件系统共享网络子网

使用共享文件系统服务创建和操作共享网络子网。

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

share_network_subnets(share_network_id)

列出所有共享网络子网及其详细信息。

参数：

share_network_id – 应列出其共享网络子网的共享网络的 ID。

返回值:

manila 共享网络子网的生成器

返回类型:

ShareNetworkSubnet

get_share_network_subnet(share_network_id, share_network_subnet_id)

列出单个共享网络子网的详细信息。

参数：

• share_network_id – 与共享网络子网关联的共享网络的 ID。

• share_network_subnet_id – 要检索的共享网络子网的 ID。

返回值:

已识别共享网络子网的详细信息

返回类型:

ShareNetworkSubnet

create_share_network_subnet(share_network_id, **attrs)

从属性创建共享网络子网

参数：

• share_network_id – 应在其中创建共享网络子网的共享网络的 ID。

• attrs (dict) – 将用于创建共享网络子网的属性。

返回值:

新共享网络子网的详细信息。

返回类型:

ShareNetworkSubnet

delete_share_network_subnet(share_network_id, share_network_subnet, ignore_missing=True)

删除共享网络子网。

参数：

• share_network_id – 与共享网络子网关联的共享网络的 ID。

• share_network_subnet – 应删除的共享网络子网的 ID。

返回值:

delete 的结果

返回类型:

无

共享文件系统共享访问规则

从共享文件系统服务创建、查看和删除共享的访问规则。访问规则在创建期间还可以限制其删除和可见性。还可以指定锁定原因。在删除访问权限时可以解除删除限制。

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

access_rules(share, **query)

列出共享上的访问规则。

返回值:

共享访问规则的生成器。

返回类型:

ShareAccessRules

get_access_rule(access_id)

列出访问规则的详细信息。

参数：

access_id – 要获取的访问规则的 ID

返回值:

已识别访问规则的详细信息。

返回类型:

ShareAccessRules

create_access_rule(share_id, **attrs)

从属性创建访问规则

返回值:

新访问规则的详细信息

参数：

• share_id – 共享的 ID

• attrs (dict) – 将用于创建 ShareAccessRules 的属性，包括 ShareAccessRules 类上的属性。

返回类型:

ShareAccessRules

delete_access_rule(access_id, share_id, ignore_missing=True, *, unrestrict=False)

删除访问规则

参数：

• access_id – 要获取的访问规则的 ID

• share_id – 共享的 ID

• unrestrict – 如果 Manila 在删除时必须尝试解除锁定

返回类型:

requests.models.Response 来自内部请求客户端的 HTTP 响应

共享文件系统共享组

与共享文件系统服务支持的共享组进行交互。

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

share_groups(**query)

列出所有共享组。

参数：

query (kwargs) –

可选的查询参数，用于限制返回的共享组。可用参数包括

• status: 按共享组状态过滤。

• name: 用于过滤资源的资源的用户定义名称。

  由。

• description: 可用于过滤资源的用户定义描述文本。

  以过滤资源。

• project_id: 用户或服务的项目 ID。

• share_server_id: 共享服务器的 UUID。

• snapshot_id: 共享的基础快照的 UUID，用于过滤

  基于请求。

• host: 后端的主机名。

• share_network_id: 用于过滤资源的共享网络的 UUID。

  资源。

• share_group_type_id: 用于过滤共享组的共享组类型 ID。

  共享组。

• share_group_snapshot_id: 源共享组快照 ID，用于列出共享组。

  列出共享组。

• share_types: 一个或多个共享类型 ID 的列表。允许

  过滤共享组。

• limit: 返回的最大共享组成员数量。

• offset: 定义共享或共享组列表起始点的偏移量。

  组列表。

• sort_key: 共享列表的排序键。

• sort_dir: 共享列表的排序方向

• name~: 可用于过滤共享、共享快照、共享网络或共享组的名称模式。

  共享快照、共享网络或共享组。

• description~: 可用于过滤共享、共享快照、共享网络或共享组的描述模式。

  过滤共享、共享快照、共享网络或共享组。

返回值:

manila 共享组资源的生成器

返回类型:

ShareGroup

get_share_group(share_group_id)

列出共享组的详细信息。

参数：

share – 要获取的共享组的 ID

返回值:

已识别共享组的详细信息

返回类型:

ShareGroup

find_share_group(name_or_id, ignore_missing=True)

查找单个共享组

参数：

• name_or_id – 共享组的名称或 ID。

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

返回值:

一个 ShareGroup 或 None

create_share_group(**attrs)

从属性创建共享组

返回值:

新共享组的详细信息

返回类型:

ShareGroup

update_share_group(share_group_id, **kwargs)

更新单个共享组的详细信息

参数：

share – 共享组的 ID

返回值:

已识别共享组的更新详细信息

返回类型:

ShareGroup

delete_share_group(share_group_id, ignore_missing=True)

删除单个共享组

参数：

share – 共享组的 ID

返回值:

共享组“删除”的结果

返回类型:

ShareGroup

共享文件系统共享组快照

与共享文件系统服务支持的共享组快照进行交互。

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

share_group_snapshots(details=True, **query)

列出所有共享组快照。

参数：

query (kwargs) –

可选的查询参数，用于限制返回的共享组快照。可用参数包括

• project_id: 拥有资源的项目的 ID。

• name: 用于过滤资源的资源的用户定义名称。

• description: 可用于过滤资源的用户定义描述文本。

• status: 按共享状态过滤

• share_group_id: 用于过滤资源的共享组的 UUID。

• limit: 返回的最大共享组快照成员数量。

• offset: 定义共享或共享组列表起始点的偏移量。

• sort_key: 共享列表的排序键。

• sort_dir: 共享列表的排序方向。有效值为 asc 或 desc。

返回值:

共享组快照资源的详细信息

返回类型:

ShareGroupSnapshot

get_share_group_snapshot(group_snapshot_id)

显示共享组快照详情

参数：

group_snapshot_id – 要获取的组快照的 ID

返回值:

组快照的详细信息

返回类型:

ShareGroupSnapshot

create_share_group_snapshot(share_group_id, **attrs)

创建共享组的时间点快照副本。

返回值:

新快照的详细信息

参数：

• attrs (dict) – 将用于创建 ShareGroupSnapshots 的属性，

• 'share_group_id' – 要创建快照的共享组的 ID。

返回类型:

ShareGroupSnapshot

reset_share_group_snapshot_status(group_snapshot_id, status)

重置共享组快照状态。

参数：

• group_snapshot_id – 要重置的共享组快照的 ID

• status – 要设置的共享组快照的状态，有效值为“creating”、“error”、“available”、“deleting”、“error_deleting”。

返回类型:

无

update_share_group_snapshot(group_snapshot_id, **attrs)

更新一个共享组快照。

参数：

• group_snapshot_id – 要更新的共享组快照的 ID

• attrs (dict) – 要在共享组快照上更新的属性

返回值:

更新后的共享组快照

返回类型:

ShareGroupSnapshot

delete_share_group_snapshot(group_snapshot_id, ignore_missing=True)

删除一个共享组快照。

参数：

group_snapshot_id – 要删除的共享组快照的 ID

返回类型:

无

共享文件系统共享元数据

从共享文件系统服务列出、获取、创建、更新和删除共享的元数据。

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

get_share_metadata(share_id)

列出共享的所有元数据。

参数：

share_id – 共享的 ID

返回值:

一个带有共享元数据的 Share。

返回类型:

分享

get_share_metadata_item(share_id, key)

通过其键从共享中检索特定的元数据项。

参数：

• share_id – 共享的 ID

• key – 共享元数据的键

返回值:

一个带有共享元数据的 Share。

返回类型:

分享

create_share_metadata(share_id, **metadata)

以键值对形式创建共享元数据。

参数：

• share_id – 共享的 ID

• metadata – 要创建的元数据

返回值:

一个带有共享元数据的 Share。

返回类型:

分享

update_share_metadata(share_id, metadata, replace=False)

更新给定共享的元数据。

参数：

• share_id – 共享的 ID

• metadata – 要创建的元数据

• replace – 一个布尔值，指示是否应替换预先存在的元数据

返回值:

一个带有共享更新元数据的 Share。

返回类型:

分享

delete_share_metadata(share_id, keys, ignore_missing=True)

删除共享上的单个元数据项，由其键标识。

参数：

• share_id – 共享的 ID

• keys – 要删除的共享元数据键列表

• ignore_missing – 一个布尔值，指示是否应忽略缺失的键。

返回值:

无

返回类型:

无

共享文件系统资源锁

创建、列出、更新和删除资源的锁。当资源被锁定时，意味着只有服务、管理员或创建锁的用户才能删除它。

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

resource_locks(**query)

列出所有资源锁。

参数：

query (kwargs) –

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

• project_id: 为其创建锁的用户项目 ID。

  创建。

• user_id: 用于过滤资源锁的用户 ID。

• all_projects: 列出所有项目的锁（仅限管理员）

• resource_id: 锁所涉及的资源的 ID

  过滤资源锁。

• resource_action: 被过滤的资源锁阻止的操作。

  锁。

• resource_type: 锁所涉及的资源的类型。

  用于过滤资源锁。

• lock_context: 锁创建者的上下文，用于过滤锁。

• lock_reason: 可用于过滤资源的锁定原因。

  锁。（也支持 lock_reason~ 的模糊搜索）

• created_since: 搜索在指定日期之后创建的资源列表。日期格式为“yyyy-mm-dd”。

  之后。

• created_before: 搜索在指定日期之前创建的资源列表。日期格式为“yyyy-mm-dd”。

  在指定的日期之前创建。

• limit: 返回的最大资源锁数量。

• offset: 定义资源锁列表起始点的偏移量。

  列表。

• sort_key: 共享列表的排序键。

• sort_dir: 共享列表的排序方向

• with_count: 是否在 API 响应中显示计数，默认为 False。此查询参数在分页时很有用。

  默认为 False。

返回值:

manila 资源锁的生成器

返回类型:

ResourceLock

get_resource_lock(resource_lock)

显示资源锁的详细信息。

参数：

resource_lock – 资源锁的 ID 或 ResourceLock 实例。

返回值:

已识别资源锁的详细信息。

返回类型:

ResourceLock

update_resource_lock(resource_lock, **attrs)

更新单个资源锁的详细信息。

参数：

• resource_lock – 资源锁的 ID 或 ResourceLock 实例。

• attrs (dict) – 要在资源锁上更新的属性

返回值:

更新后的资源锁

返回类型:

ResourceLock

delete_resource_lock(resource_lock, ignore_missing=True)

删除单个资源锁

参数：

resource_lock – 资源锁的 ID 或 ResourceLock 实例。

返回值:

delete 的结果

返回类型:

无

create_resource_lock(**attrs)

锁定资源。

参数：

attrs (dict) –

将用于创建 ResourceLock 的属性，包括 ResourceLock 类上的属性。可用参数包括

• resource_id: 要锁定的资源的 ID。

• resource_type: 资源的类型（共享、access_rule）。

• resource_action: 要锁定的操作（删除、显示）。

• lock_reason: 锁定资源的原因

  (可选)。

返回值:

锁的详细信息

返回类型:

ResourceLock