管理服务器上的卷。

上提供的方法 client.volumes

class VolumeCollection
create(name=None, **kwargs)

创建卷。

参数:
  • name (str) -- 卷的名称。如果未指定,引擎将生成一个名称。

  • driver (str) -- 用于创建卷的驱动程序的名称

  • driver_opts (dict) -- 作为键值字典的驱动程序选项

  • labels (dict) -- 要在卷上设置的标签

返回:

创建的卷。

返回类型:

(Volume )

抛出:

docker.errors.APIError -- 如果服务器返回错误。

示例

>>> volume = client.volumes.create(name='foobar', driver='local',
        driver_opts={'foo': 'bar', 'baz': 'false'},
        labels={"key": "value"})
get(volume_id)

拿一本书来。

参数:

volume_id (str) -- 卷名。

返回:

音量。

返回类型:

(Volume )

抛出:
  • docker.errors.NotFound -- 如果该卷不存在。

  • docker.errors.APIError -- 如果服务器返回错误。

list(**kwargs)

列出卷。类似于 docker volume ls 指挥部。

参数:

filters (dict) -- 服务器端列表过滤选项。

返回:

这些卷。

返回类型:

(列表 Volume )

抛出:

docker.errors.APIError -- 如果服务器返回错误。

prune(filters=None)

删除未使用的卷

参数:

filters (dict) -- 要在清理列表上处理的筛选器。

返回:

包含已删除卷名的列表和回收的磁盘空间量(以字节为单位)的字典。

返回类型:

(dict)

抛出:

docker.errors.APIError -- 如果服务器返回错误。

卷对象

class Volume

一本书。

id

对象的ID。

short_id

对象的ID,截断为12个字符。

name

卷的名称。

attrs

服务器中此对象的原始表示形式。

reload()

再次从服务器加载此对象并更新 attrs 使用新的数据。

remove(force=False)

删除此卷。

参数:

force (bool) -- 强制删除已由卷驱动程序插件从带外删除的卷。

抛出:

docker.errors.APIError -- 如果无法删除卷。