openstack.block_storage.v3.volume

Volume 类

Volume 类继承自 Resource。

class openstack.block_storage.v3.volume.Volume(_synchronized=False, connection=None, **attrs)

基础资源

参数：

• _synchronized (bool) – 这不打算直接使用。请参阅 new() 和 existing()。

• connection (openstack.connection.Connection) – 对正在使用的 Connection 的引用。默认为 None，允许在单元测试中等情况下使用不带活动 Connection 的 Resource 对象。Resource 代码中对 self._connection 的使用应使用 None 检查进行保护。

resource_key = 'volume'

资源的单数形式的键。

resources_key = 'volumes'

资源的复数形式的键。

base_path = '/volumes'

此资源的 URI 的基本部分。

allow_fetch = True

允许对此资源进行获取操作。

allow_create = True

允许对此资源进行创建操作。

allow_delete = True

允许对此资源进行删除操作。

allow_commit = True

允许对此资源进行更新操作。

allow_list = True

允许对此资源进行列表操作。

attachments

实例附加信息。如果此卷附加到服务器实例，则 attachments 列表包含附加服务器的 UUID、附加 UUID、附加主机的名称（如果有）、卷 UUID、设备和设备 UUID。否则，此列表为空。

availability_zone

可用区。

backup_id

要从现有备份创建卷，请指定现有卷备份的 ID。（自 3.47 起）

consistency_group_id

一致性组的 ID。

consumes_quota

此资源是否消耗配额。未计入配额使用的资源通常是执行操作的临时内部资源。（自 3.65 起）

cluster_name

卷后端的集群名称。（自 3.61 起）

created_at

此卷创建的时间戳。

description

卷描述。

encryption_key_id

加密密钥的 UUID。仅包含在加密卷中。（自 3.64 起）

extended_replication_status

此卷上的扩展复制状态。

group_id

卷所属组的 ID。（自 3.13 起）

host

卷的当前后端。

image_id

要创建卷的镜像的 ID。创建可引导卷需要此项。

is_bootable

启用或禁用可引导属性。您可以从可引导卷启动实例。类型：bool

is_encrypted

True 如果此卷已加密，则为 False 如果未加密。类型：bool

is_multiattach

卷是否可共享。

migration_id

卷的名称基于后端上的哪个卷 ID。

migration_status

此卷的迁移状态（None 表示当前没有正在进行的迁移）。

project_id

与当前后端关联的项目 ID。

replication_driver_data

复制驱动程序设置的数据

provider_id

卷的提供程序 ID。（自 3.21 起）

replication_status

此卷上的复制状态。

scheduler_hints

卷的调度器提示

service_uuid

用于指示为特定卷提供服务的 volume-service 位于哪个节点上的唯一标识符。（自 3.48 起）

shared_targets

一个指示连接卷的主机是否应锁定整个附加/分离过程，还是不应锁定的指标。true 表示仅在主机上运行的 iSCSI 发起程序不支持手动扫描时才使用锁，false 表示从不使用锁，而 null 表示始终使用锁。请参阅 os-brick 的 guard_connection 上下文管理器。默认值为 True。（自 3.48 起）

size

卷的大小，以 GB 为单位。

snapshot_id

要从现有快照创建卷，请指定现有卷快照的 ID。如果指定，则卷将在与快照相同的可用区中创建，并且大小与快照相同。

source_volume_id

要从现有卷创建卷，请指定现有卷的 ID。如果指定，则卷将与源卷的大小相同。

status

以下值之一：creating、available、attaching、in-use deleting、error、error_deleting、backing-up、restoring-backup、error_restoring。有关这些状态的详细信息，请参阅块存储 API 文档。

updated_at

更新资源的时间和日期。

user_id

与卷关联的用户 ID

volume_image_metadata

关于镜像的一个或多个元数据键值对

volume_type

关联的卷类型名称。

volume_type_id

卷的关联卷类型 ID。（自 3.61 起）

extend(session, size)

扩展卷大小。

complete_extend(session, error=False)

完成卷扩展操作

set_bootable_status(session, bootable=True)

设置卷可引导状态标志

set_readonly(session, readonly)

设置卷只读标志

set_image_metadata(session, metadata)

设置卷上的图像元数据键值对

delete_image_metadata(session)

删除卷上的所有图像元数据

delete_image_metadata_item(session, key)

删除卷上的单个图像元数据

reset_status(session, status=None, attach_status=None, migration_status=None)

重置卷状态（管理员操作）

revert_to_snapshot(session, snapshot_id)

将卷恢复到其快照

attach(session, mountpoint, instance=None, host_name=None)

将卷附加到服务器

detach(session, attachment, force=False, connector=None)

将卷从服务器分离

classmethod manage(session, host, ref, name=None, description=None, volume_type=None, availability_zone=None, metadata=None, bootable=False, cluster=None)

管理现有卷。

unmanage(session)

取消管理卷

retype(session, new_type, migration_policy=None)

更改卷类型

migrate(session, host=None, force_host_copy=False, lock_volume=False, cluster=None)

迁移卷

complete_migration(session, new_volume_id, error=False)

完成卷迁移

force_delete(session)

强制删除卷

upload_to_image(session, image_name, force=False, disk_format=None, container_format=None, visibility=None, protected=None)

将卷上传到镜像服务

reserve(session)

保留卷

unreserve(session)

释放卷

begin_detaching(session)

更新卷状态为‘正在分离’

abort_detaching(session)

将卷状态回滚为‘使用中’

init_attachment(session, connector)

初始化卷连接

terminate_attachment(session, connector)

终止卷连接