
Like placement's resource provider inventory API and keystone's old extensions API, this is yet another example of an API that returns an object with property names as keys and all other attributes as the values, e.g. we see: { "os_admin_user": { ... }, ... } rather than: [ { "name": "os_admin_user", ... }, ,,, ] Change-Id: I8e2ae8545cfaf32ced6d086a0921732f16282216 Co-authored-by: KIM SOJUNG <thwjd2717@gmail.com> Co-authored-by: GA EUM KIM <rkdms7220@naver.com> Co-authored-by: EunYoung Kim <lilac94.kim@gmail.com> Co-authored-by: hyemin Choi <dropmoon3523@gmail.com> Co-authored-by: Antonia Gaete <antoniagaete@osuosl.org> Co-authored-by: YeJun, Jung <yejun614@naver.com>
111 lines
3.1 KiB
ReStructuredText
111 lines
3.1 KiB
ReStructuredText
Image API v2
|
|
============
|
|
|
|
For details on how to use image, see :doc:`/user/guides/image`
|
|
|
|
.. automodule:: openstack.image.v2._proxy
|
|
|
|
The Image v2 Class
|
|
------------------
|
|
|
|
The image high-level interface is available through the ``image`` member of a
|
|
:class:`~openstack.connection.Connection` object. The ``image`` member will
|
|
only be added if the service is detected.
|
|
|
|
Image Operations
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: create_image, import_image, upload_image, download_image,
|
|
update_image, delete_image, get_image, find_image, images,
|
|
deactivate_image, reactivate_image, stage_image,
|
|
add_tag, remove_tag
|
|
|
|
Member Operations
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: add_member, remove_member, update_member, get_member, find_member,
|
|
members
|
|
|
|
Task Operations
|
|
^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: tasks, create_task, get_task, wait_for_task
|
|
|
|
Schema Operations
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: get_images_schema, get_image_schema, get_members_schema,
|
|
get_member_schema, get_tasks_schema, get_task_schema,
|
|
get_metadef_namespace_schema, get_metadef_namespaces_schema,
|
|
get_metadef_resource_type_schema, get_metadef_resource_types_schema,
|
|
get_metadef_object_schema, get_metadef_objects_schema,
|
|
get_metadef_property_schema, get_metadef_properties_schema,
|
|
get_metadef_tag_schema, get_metadef_tags_schema
|
|
|
|
Service Info Discovery Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: stores, get_import_info
|
|
|
|
|
|
Metadef Namespace Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: create_metadef_namespace, delete_metadef_namespace,
|
|
get_metadef_namespace, metadef_namespaces, update_metadef_namespace
|
|
|
|
|
|
Metadef Object Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: create_metadef_object, delete_metadef_object,
|
|
get_metadef_object, metadef_objects, update_metadef_object
|
|
|
|
Metadef Resource Type Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: metadef_resource_types, metadef_resource_type_associations,
|
|
create_metadef_resource_type_association,
|
|
delete_metadef_resource_type_association
|
|
|
|
|
|
Metadef Property Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: create_metadef_property, update_metadef_property,
|
|
delete_metadef_property, get_metadef_property
|
|
|
|
|
|
Helpers
|
|
^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: wait_for_delete
|
|
|
|
|
|
Cache Operations
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.image.v2._proxy.Proxy
|
|
:noindex:
|
|
:members: cache_delete_image, queue_image, get_image_cache, clear_cache
|