Consulta de imágenes_Image Management Service

Función

Esta API se utiliza para consultar imágenes utilizando criterios de búsqueda y para mostrar las imágenes en una lista.

NOTA:

Ya no se pueden consultar imágenes de Windows.

URI

GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,flavor_id,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at,architecture}

NOTA:

Puede escribir un signo de interrogación (?) y un ampersand (&) al final del URI para definir varios criterios de búsqueda. Para obtener más información, consulte la solicitud de ejemplo.

**Tabla 1** Descripción de parámetros
Parámetro	Obligatorio	Tipo	Descripción
__isregistered	No	String	Especifica si la imagen está disponible. El valor puede ser true. El valor es true para todas las API de extensión de forma predeterminada. Los usuarios comunes solo pueden consultar las imágenes para las que el valor de este parámetro es true.
__imagetype	No	String	Especifica el tipo de imagen. Se admiten los siguientes tipos: Imagen pública: El valor es gold. Imagen privada: El valor es private. Imagen compartida: El valor es shared. Imagen de Marketplace: El valor es market. NOTA: Se comparte el __imagetype de imágenes que comparte con otros tenants o aquellos otros tenants que comparten con usted y que ha aceptado es shared. Puede utilizar el campo owner para distinguir los dos tipos de imágenes compartidas. Puede usar member_status para filtrar las imágenes compartidas que haya aceptado.
__whole_image	No	Boolean	Especifica si la imagen es una imagen completa de ECS. El valor puede ser true o false.
__system__cmkid	No	String	Especifica el ID de la clave utilizada para cifrar la imagen. Puede obtener el ID desde la consola de IMS o mediante invocación a la API Consulta de detalles de imagen (API de OpenStack nativo).
protected	No	Boolean	Especifica si la imagen está protegida. El valor puede ser true o false. Establezca el valor de true cuando consulte imágenes públicas. Este parámetro es opcional cuando consulta imágenes privadas.
visibility	No	String	Especifica si la imagen está disponible para otros tenants. Los valores disponibles incluyen: public: imagen pública private: imagen privada shared: imagen compartida
owner	No	String	Especifica el tenant al que pertenece la imagen.
id	No	String	Especifica el ID de imagen.
status	No	String	Especifica el estado de la imagen. El valor puede ser uno de los siguientes: queued: indica que los metadatos de la imagen ya han sido creados, y que está listo para que el archivo de imagen se cargue. saving: indica que el archivo de imagen se está cargando en el almacenamiento de backend. deleted: indica que la imagen ha sido borrada. killed: indica que se produce un error al cargar la imagen. active: indica que la imagen está disponible para su uso.
name	No	String	Especifica el nombre de la imagen. Se utiliza la coincidencia exacta. Para una descripción detallada, consulte Atributos de imagen.
flavor_id	No	String	Especifica el ID de tipo ECS utilizado para filtrar las imágenes públicas disponibles. Nota: Solo puede especificar un ID de variante. Solo puede especificar un ID de variante de ECS y no puede especificar un ID de variante de BMS. Para filtrar imágenes públicas admitidas por una variante de BMS, utilice el criterio de filtro __support_s4l=true. s4l indica board_type de la variante BMS physical.s4.large. Consulte Métodos de consulta comunes para obtener un ejemplo de invocación.
container_format	No	String	Especifica el tipo de contenedor. El valor es bare.
disk_format	No	String	Especifica el formato de imagen. El valor puede ser zvhd2, vhd, zvhd, raw, iso o qcow2. El valor predeterminado es zvhd2 para una imagen no ISO.
min_ram	No	Integer	Especifica el tamaño mínimo de memoria (MB) necesario para ejecutar la imagen. El valor del parámetro depende de las especificaciones del . Generalmente, el valor es 0.
min_disk	No	Integer	Especifica el espacio mínimo en disco (GB) necesario para ejecutar la imagen. El valor oscila entre 40 GB y 255 GB.
__os_bit	No	String	Especifica la arquitectura del sistema operativo, de 32 bits o 64 bits.
__platform	No	String	Especifica el tipo de plataforma de imagen. El valor puede ser Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, CoreOS, EulerOS, Huawei Cloud EulerOS, u Other.
marker	No	String	Especifica el número inicial desde el que se consultan las imágenes. El valor es el ID de la imagen.
limit	No	Integer	Especifica el número de imágenes que se devolverán. El valor es un entero y es 500 de forma predeterminada.
sort_key	No	String	Especifica el campo para ordenar los resultados de la consulta. El valor puede ser un atributo de la imagen: name, container_format, disk_format, status, id, size, o created_at. El valor predeterminado es create_at.
sort_dir	No	String	Especifica si los resultados de la consulta se ordenan en orden ascendente o descendente. Su valor puede ser desc (predeterminado) o asc. Este parámetro se utiliza junto con el parámetro sort_key. El valor predeterminado es desc.
__os_type	No	String	Especifica el tipo de sistema operativo de imagen. Los valores disponibles incluyen: Linux Windows Other
tag	No	String	Especifica una etiqueta agregada a una imagen. Las etiquetas se pueden utilizar como filtro para consultar imágenes. NOTA: Se ha actualizado la función de etiquetado. Si las etiquetas añadidas antes de la actualización de la función tienen el formato de "Key.Value", consulte las etiquetas de utilizando "Key=Value". Por ejemplo, una etiqueta existente es a.b. Después de la actualización de la función de etiqueta, consulte la etiqueta usando "tag=a=b".
member_status	No	String	Especifica el estado del miembro. El valor puede ser accepted, rejected, o pending. accepted: indica que la imagen compartida es aceptada. rejected indica que la imagen compartida por otros es rechazada. pending indica que la imagen compartida por otros necesita ser confirmada. Para utilizar este parámetro, establezca visibility en shared durante la consulta.
__support_kvm	No	String	Especifica si la imagen admite KVM. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario.
__support_xen	No	String	Especifica si la imagen admite Xen. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario.
__support_largememory	No	String	Especifica si la imagen admite ECS de memoria grande. Si la imagen admite ECS de memoria grande, el valor es true. De lo contrario, este parámetro no es necesario. Para conocer los sistemas operativos compatibles, consulte SO compatibles con diferentes tipos de ECS.
__support_diskintensive	No	String	Especifica si la imagen admite ECS con uso intensivo de disco. Si la imagen admite ECS con uso intensivo de disco, el valor es true. De lo contrario, este parámetro no es necesario.
__support_highperformance	No	String	Especifica si la imagen admite ECS de alto rendimiento. Si la imagen admite ECS de alto rendimiento, el valor es true. De lo contrario, este parámetro no es necesario.
__support_xen_gpu_type	No	String	Especifica si la imagen admite ECS acelerados por GPU en la plataforma Xen. Consulte Tabla 2 por su valor. Si la imagen no admite ECS acelerados por GPU en la plataforma Xen, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen y __support_kvm.
__support_kvm_gpu_type	No	String	Especifica si la imagen admite ECS acelerados por GPU en la plataforma KVM. Consulte Tabla 3 por su valor. Si la imagen no admite ECS acelerados por GPU en la plataforma KVM, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen y __support_kvm.
__support_xen_hana	No	String	Especifica si la imagen admite los ECS de HANA en la plataforma Xen. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen y __support_kvm.
__support_kvm_infiniband	No	String	Especifica si la imagen admite los ECS con las NIC de InfiniBand en la plataforma KVM. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen.
virtual_env_type	No	String	Especifica el entorno en el que se utiliza la imagen. El valor puede ser FusionCompute, Ironic, DataImage, o IsoImage. Para una imagen de (imagen de disco del sistema), el valor es FusionCompute. Para una imagen de disco de datos, el valor es de DataImage. Para una imagen BMS, el valor es Ironic. Para una imagen ISO, el valor es IsoImage.
enterprise_project_id	No	String	Especifica el proyecto de empresa al que pertenecen las imágenes que se van a consultar. Si el valor es 0, se consultarán las imágenes del proyecto de empresa default. Si el valor es UUID, se deben consultar las imágenes del proyecto de empresa correspondientes al UUID. Si el valor es all_granted_eps, se consultarán las imágenes de todos los proyectos de empresa. Para obtener más información sobre proyectos empresariales y cómo obtener los ID de proyectos empresariales, consulte Centro empresarial.
created_at	No	String	Especifica la hora en que se creó la imagen. Las imágenes se pueden consultar por tiempo. El valor tiene el formato de Operator:UTC time. Se admiten los siguientes operadores: gt: mayor que gte: mayor o igual que lt: menor que lte: menor o igual que eq: igual que neq: no es igual que El formato de hora es yyyy-MM-ddThh:mm:ssZ o yyyy-MM-dd hh:mm:ss. Por ejemplo, para consultar imágenes creadas antes del 28 de octubre de 2018 10:00:00, establezca el valor de created_at de la siguiente manera: created_at=lt:2018-10-28T10:00:00Z
updated_at	No	String	Especifica la hora a la que se modificó la imagen. Las imágenes se pueden consultar por tiempo. El valor tiene el formato de Operator:UTC time. Se admiten los siguientes operadores: gt: mayor que gte: mayor o igual que lt: menor que lte: menor o igual que eq: igual que neq: no es igual que El formato de hora es yyyy-MM-ddThh:mm:ssZ o yyyy-MM-dd hh:mm:ss. Por ejemplo, para consultar imágenes actualizadas antes del 28 de octubre de 2018 10:00:00, establezca el valor de update_at de la siguiente manera: updated_at=lt:2018-10-28T10:00:00Z
architecture	No	String	Especifica el tipo de arquitectura de imagen. El valor puede ser: x86 arm

Solicitud

Parámetros de solicitud

Ninguna

Ejemplo de solicitud

Consulta de imágenes públicas (los resultados se ordenarán por nombre de imagen y solo se devolverá una imagen)

GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1

Métodos de consulta comunes

Imágenes públicas
GET /v2/cloudimages?__imagetype=gold&visibility=public&protected=true
Imágenes privadas
GET /v2/cloudimages?owner={project_id}
Imágenes compartidas disponibles
GET /v2/cloudimages?member_status=accepted&visibility=shared&__imagetype=shared
Imágenes rechazadas
GET /v2/cloudimages?member_status=rejected&visibility=shared&__imagetype=shared
Imágenes no aceptadas
GET /v2/cloudimages?member_status=pending&visibility=shared&__imagetype=shared
Imágenes públicas compatibles con una variante de BMS
GET /v2/cloudimages?__imagetype=gold&__support_xxx=true&virtual_env_type=Ironic

Respuesta

Parámetros de respuesta

Parámetro	Tipo	Descripción
images	Array of objects	Especifica los detalles de la imagen. Consulte Tabla 2 para obtener más detalles.

Parámetro

Tipo

Descripción

images

Array of objects

Especifica los detalles de la imagen.

Consulte Tabla 2 para obtener más detalles.

**Tabla 2** Descripción de la estructura de datos del campo de imágenes
Parámetro	Tipo	Descripción
file	String	Especifica la dirección URL para cargar y descargar el archivo de imagen.
owner	String	Especifica el tenant al que pertenece la imagen.
id	String	Especifica el ID de imagen.
size	Long	Este parámetro no está disponible actualmente.
self	String	Especifica la dirección URL de la imagen.
schema	String	Especifica el esquema de imagen.
status	String	Especifica el estado de la imagen. El valor puede ser uno de los siguientes: queued: indica que los metadatos de la imagen ya han sido creados, y que está listo para que el archivo de imagen se cargue. saving: indica que el archivo de imagen se está cargando en el almacenamiento de backend. deleted: indica que la imagen ha sido borrada. killed: indica que se produce un error al cargar la imagen. active: indica que la imagen está disponible para su uso.
tags	Array of strings	Especifica las etiquetas de la imagen, a través de las cuales puede gestionar imágenes privadas a su manera. Puede usar la API de etiquetas de imagen para agregar diferentes etiquetas a cada imagen y filtrar imágenes por etiqueta.
visibility	String	Especifica si la imagen está disponible para otros tenants. Los valores disponibles incluyen: private: imagen privada public: imagen pública shared: imagen compartida
name	String	Especifica el nombre de la imagen. Para obtener una descripción detallada, consulte Atributos de imagen.
checksum	String	Este parámetro no está disponible actualmente.
protected	Boolean	Especifica si la imagen está protegida. No se puede eliminar una imagen protegida. El valor puede ser true o false.
container_format	String	Especifica el tipo de contenedor.
min_ram	Integer	Especifica el tamaño mínimo de memoria (MB) necesario para ejecutar la imagen. El valor del parámetro depende de las especificaciones del . Generalmente, el valor es 0.
max_ram	String	Especifica la memoria máxima (MB) de la imagen. Puede configurar este parámetro en función de las especificaciones del . Generalmente, no se necesita configurar este parámetro.
updated_at	String	Especifica la hora a la que se actualizó la imagen. El valor está en formato UTC.
__os_bit	String	Especifica la arquitectura del sistema operativo, de 32 bits o 64 bits.
__os_version	String	Especifica la versión del sistema operativo.
__description	String	Proporciona información adicional sobre la imagen. Para una descripción detallada, consulte Atributos de imagen.
disk_format	String	Especifica el formato de imagen. El valor puede ser zvhd2, vhd, zvhd, raw, iso o qcow2. El valor predeterminado es zvhd2 para una imagen no ISO.
__isregistered	String	Especifica si la imagen se ha registrado. El valor puede ser true o false.
__platform	String	Especifica el tipo de plataforma de imagen. El valor puede ser Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS o EulerOS.
__os_type	String	Especifica el tipo de SO. El valor puede ser Linux, Windows, u Other.
min_disk	Integer	Especifica el espacio mínimo en disco (GB) necesario para ejecutar la imagen. El valor oscila entre 40 GB y 255 GB.
virtual_env_type	String	Especifica el entorno en el que se utiliza la imagen. El valor puede ser FusionCompute, Ironic, DataImage, o IsoImage. Para una imagen de , el valor es FusionCompute. Para una imagen de disco de datos, el valor es de DataImage. Para una imagen de , el valor es Ironic. Para una imagen ISO, el valor es IsoImage.
__image_source_type	String	Especifica el tipo de almacenamiento de backend de imagen. Actualmente, solo se admite UDS.
__imagetype	String	Especifica el tipo de imagen. Se admiten los siguientes tipos: Imagen pública: El valor es gold. Imagen privada: El valor es private. Imagen compartida: El valor es shared. Imagen de Marketplace: El valor es market.
created_at	String	Especifica la hora en que se creó la imagen. El valor está en formato UTC.
virtual_size	Integer	Este parámetro no está disponible actualmente.
__originalimagename	String	Especifica el ID de la imagen principal. Si la imagen es una imagen pública o creada a partir de un archivo de imagen, este valor se deja vacío.
__backup_id	String	Especifica el ID de copia de respaldo. Para crear una imagen mediante una copia de respaldo, establezca el valor en el ID de copia de respaldo. De lo contrario, este valor se deja vacío.
__productcode	String	Especifica el ID de producto de una imagen de Marketplace.
__image_size	String	Especifica el tamaño (bytes) del archivo de imagen.
__data_origin	String	Especifica el origen de la imagen. Si la imagen es una imagen pública, este parámetro se deja vacío.
__lazyloading	String	Especifica si la imagen admite la carga lenta. El valor puede ser true, false, True o False.
active_at	String	Especifica la hora en que el estado de la imagen se cambia a active.
__image_displayname	String	Especifica el nombre de la imagen.
__os_feature_list	String	Especifica atributos adicionales de la imagen. El valor es una lista (en formato JSON) de características avanzadas compatibles con la imagen.
__support_kvm	String	Especifica si la imagen admite KVM. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario.
__support_xen	String	Especifica si la imagen admite Xen. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario.
__support_largememory	String	Especifica si la imagen admite ECS de memoria grande. Si la imagen admite ECS de memoria grande, el valor es true. De lo contrario, este parámetro no es necesario.
__support_diskintensive	String	Especifica si la imagen admite ECS con uso intensivo de disco. Si la imagen admite ECS con uso intensivo de disco, el valor es true. De lo contrario, este parámetro no es necesario.
__support_highperformance	String	Especifica si la imagen admite ECS de alto rendimiento. Si la imagen admite ECS de alto rendimiento, el valor es true. De lo contrario, este parámetro no es necesario.
__support_xen_gpu_type	String	Especifica si la imagen admite ECS acelerados por GPU en la plataforma Xen. Consulte Tabla 2 por su valor. Si la imagen no admite ECS acelerados por GPU en la plataforma Xen, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen y __support_kvm.
__support_kvm_gpu_type	String	Especifica si la imagen admite ECS acelerados por GPU en la plataforma KVM. Consulte Tabla 3 por su valor. Si la imagen no admite ECS acelerados por GPU en la plataforma KVM, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen y __support_kvm.
__support_xen_hana	String	Especifica si la imagen admite los ECS de HANA en la plataforma Xen. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen y __support_kvm.
__support_kvm_infiniband	String	Especifica si la imagen admite los ECS con las NIC de InfiniBand en la plataforma KVM. En caso afirmativo, el valor es true. De lo contrario, este parámetro no es necesario. Este atributo no puede coexistir con __support_xen.
__system_support_market	Boolean	Especifica si una imagen se puede publicar en Marketplace. true:: admitido false: no admitido
__is_offshelved	String	Especifica si se ha desconectado la imagen del Marketplace. true: La imagen se ha desconectado. false: La imagen no se ha desconectado.
enterprise_project_id	String	Especifica el proyecto empresarial al que pertenece la imagen. Si el valor es 0 o se deja en blanco, la imagen pertenece al proyecto empresarial predeterminado. Si el valor es un UUID, la imagen pertenece al proyecto empresarial correspondiente al UUID. Para obtener más información sobre proyectos empresariales, consulte Centro empresarial.
__root_origin	String	Especifica que la imagen se crea a partir de un archivo de imagen externo. Valor: file
__sequence_num	String	Especifica el número de ranura de disco del sistema de de la imagen. Valor de ejemplo: 0
__support_fc_inject	String	Especifica si la imagen admite la inyección de contraseña/clave privada con Cloud-Init. Si el valor se establece en true, no se admite la inyección de contraseña/clave privada con Cloud-Init. NOTA: Este parámetro solo es válido para imágenes de disco del sistema ECS.
hw_firmware_type	String	Especifica el modo de arranque de . Los valores disponibles incluyen: bios indica el modo de arranque del BIOS. uefi indica el modo de arranque UEFI.
hw_vif_multiqueue_enabled	String	Especifica si la imagen admite colas múltiples de NIC. El valor puede ser true o false.
__support_arm	String	Especifica si la imagen utiliza la arquitectura ARM. El valor puede ser true o false.
__support_agent_list	String	Especifica los agentes configurados para la imagen. hss: El agente de Host Security Service (HSS) está configurado para la imagen. ces: El agente de monitoreo del host está configurado para la imagen. Valor de ejemplo: "__support_agent_list": "hss,ces" NOTA: Si la respuesta no contiene este campo, el HSS y los agentes de monitoreo del host no están configurados para la imagen.
__system__cmkid	String	Especifica el ID de la clave utilizada para cifrar la imagen.
__account_code	String	Especifica el identificador de carga de la imagen.
__support_amd	String	Especifica si la imagen utiliza la arquitectura x86 de AMD. El valor puede ser true o false.

Ejemplo de respuesta

STATUS CODE 200

      
       
         
         {
  "images": [
    {
      "schema": "/v2/schemas/image",
      "min_disk": 100,
      "created_at": "2018-09-06T14:03:27Z",
      "__image_source_type": "uds",
      "container_format": "bare",
      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
      "updated_at": "2018-09-06T15:17:33Z",
      "protected": true,
      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
      "__isregistered": "true",
      "min_ram": 2048,
      "__lazyloading": "true",
      "owner": "1bed856811654c1cb661a6ca845ebc77",
      "__os_type": "Linux",
      "__imagetype": "gold",
      "visibility": "public",
      "virtual_env_type": "FusionCompute",
      "tags": [],
      "__platform": "CentOS",
      "size": 0,
      "__os_bit": "64",
      "__os_version": "CentOS 7.3 64bit",
      "name": "CentOS 7.3 64bit vivado",
      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
      "disk_format": "zvhd2",
      "virtual_size": null,
      "hw_firmware_type": "bios",
      "status": "active",
      "__support_fc_inject":"true"
    },
    {
      "schema": "/v2/schemas/image",
      "min_disk": 100,
      "created_at": "2018-09-06T14:03:05Z",
      "__image_source_type": "uds",
      "container_format": "bare",
      "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
      "updated_at": "2018-09-25T14:27:40Z",
      "protected": true,
      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
      "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
      "__isregistered": "true",
      "min_ram": 2048,
      "__lazyloading": "true",
      "owner": "1bed856811654c1cb661a6ca845ebc77",
      "__os_type": "Linux",
      "__imagetype": "gold",
      "visibility": "public",
      "virtual_env_type": "FusionCompute",
      "tags": [],
      "__platform": "CentOS",
      "size": 0,
      "__os_bit": "64",
      "__os_version": "CentOS 7.3 64bit",
      "name": "CentOS 7.3 64bit with sdx",
      "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
      "disk_format": "zvhd2",
      "virtual_size": null,
      "hw_firmware_type": "bios",
      "status": "active",
      "__support_fc_inject":"true"
    }
  ]
}

        

      
     

Valores devueltos

Normal
200

Anormal

Valor devuelto	Descripción
400 Bad Request	Error de solicitud. Para obtener más información sobre el código de error devuelto, consulte Códigos de error.
401 Unauthorized	Error de autenticación.
403 Forbidden	Usted no tiene los derechos para realizar la operación.
404 Not Found	No se encontró el recurso solicitado.
500 Internal Server Error	Error interno del servicio.
503 Service Unavailable	El servicio no está disponible.

Consulta de imágenes