Image API v1

有关如何使用镜像的详细信息,请参阅 使用 OpenStack Image

Image v1 类

镜像高级接口可通过 Connection 对象的 image 成员访问。只有检测到服务时,才会添加 image 成员。

class openstack.image.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)
upload_image(**attrs)

上传新的镜像

参数:

attrs (dict) – 关键字参数,将用于创建一个 Image,包含 Image 类上的属性。

返回值:

镜像创建的结果

返回类型:

镜像

delete_image(image, ignore_missing=True)

删除镜像

参数:
  • image – 该值可以是镜像的 ID 或一个 Image 实例。

  • ignore_missing (bool) – 当设置为 False 时,如果镜像不存在,将引发 NotFoundException。当设置为 True 时,尝试删除不存在的镜像时不会引发异常。

返回值:

find_image(name_or_id, ignore_missing=True)

查找单个镜像

参数:
  • name_or_id – 镜像的名称或 ID。

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

返回值:

一个 Image 或 None

get_image(image)

获取单个镜像

参数:

image – 该值可以是镜像的 ID 或一个 Image 实例。

返回值:

一个 Image

引发:

NotFoundException,当找不到资源时。

images(**query)

返回镜像生成器

参数:

query (kwargs) – 可选的查询参数,用于限制返回的资源。

返回值:

镜像对象生成器

返回类型:

镜像

update_image(image, **attrs)

更新镜像

参数:
  • image – 镜像的 ID 或一个 Image 实例。

  • attrs – 要更新到 image 表示的镜像上的属性。

返回值:

更新后的镜像

返回类型:

镜像