openstack.block_storage.v3.transfer

Volume Transfer 类

The Volume Transfer 类继承自 Resource

class openstack.block_storage.v3.transfer.Transfer(_synchronized=False, connection=None, **attrs)

基础资源

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

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

resource_key = 'transfer'

资源的单数形式的键。

resources_key = 'transfers'

资源的复数形式的键。

base_path = '/volume-transfers'

此资源的 URI 的基本部分。

allow_create = True

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

allow_delete = True

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

allow_fetch = True

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

allow_list = True

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

id

传输的 UUID。

created_at

创建资源的时间和日期。

name

要传输的卷的名称。

volume_id

要传输的卷的 ID。

auth_key

传输的认证密钥。

与此卷关联的链接列表。类型: list

no_snapshots

是否传输快照

create(session, prepend_key=True, base_path=None, **, resource_request_key=None, resource_response_key=None, microversion=None, **params)

创建卷传输。

参数:
  • session (Adapter) – 用于发出此请求的会话。

  • prepend_key – 一个布尔值,指示是否应在资源创建请求中将 resource_key 附加到请求体之前。默认为 True。

  • base_path (str) – 创建资源的 URI 的基本部分,如果与 base_path 不同。

  • resource_request_key (str) – 覆盖在将键附加到请求体时使用 self.resource_key 的用法。如果 prepend_key 为 false,则忽略。

  • resource_response_key (str) – 覆盖在处理响应体时使用 self.resource_key 的用法。如果 prepend_key 为 false,则忽略。

  • microversion (str) – 覆盖协商版本使用的 API 版本。

  • params (dict) – 传递的额外参数。

返回值:

Resource 实例。

引发:

MethodNotSupported 如果 Resource.allow_create 未设置为 True

fetch(session, requires_id=True, base_path=None, error_message=None, skip_cache=False, **, resource_response_key=None, microversion=None, **params)

获取卷传输。

参数:
  • session (Adapter) – 用于发出此请求的会话。

  • requires_id (boolean) – 一个布尔值,指示资源 ID 是否应作为请求的 URI 的一部分。

  • base_path (str) – 获取资源的 URI 的基本部分,如果与 base_path 不同。

  • error_message (str) – 如果请求的对象不存在,则返回的错误消息。

  • skip_cache (bool) – 一个布尔值,指示是否应跳过此调用的可选 API 缓存。

  • resource_response_key (str) – 覆盖在处理响应体时使用 self.resource_key 的用法。

  • microversion (str) – 覆盖协商版本使用的 API 版本。

  • params (dict) – 可以使用的额外参数。

返回值:

Resource 实例。

引发:

MethodNotSupported 如果 Resource.allow_fetch 未设置为 True

引发:

NotFoundException 如果未找到资源。

delete(session, error_message=None, **, microversion=None, **kwargs)

删除卷传输。

参数:
  • session (Adapter) – 用于发出此请求的会话。

  • microversion (str) – 覆盖协商版本使用的 API 版本。

  • kwargs (dict) – 将传递给 _prepare_request() 的参数

返回值:

Resource 实例。

引发:

MethodNotSupported 如果 Resource.allow_commit 未设置为 True

引发:

NotFoundException 如果未找到资源。

accept(session, **, auth_key=None)

接受卷传输。

参数:
  • session – 用于进行此请求的会话。

  • auth_key – 卷传输的认证密钥。

返回值:

Transfer 实例。