Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Image Management Service/ Referencia de la API/ Las API de Native OpenStack/ Imagen (Native OpenStack APIs)/ Consulta de imágenes (Native OpenStack API)
Actualización más reciente 2022-11-07 GMT+08:00
Ver PDF
Compartir

Consulta de imágenes (Native OpenStack API)

Función

Esta API se utiliza para obtener la lista de imágenes.

Esta API no devuelve el resultado completo a la vez, pero usa paginación.

Paginación

Paginación se refiere a la función de devolver un subconjunto de un grupo de imágenes, un enlace para obtener el siguiente conjunto de imágenes, y un enlace del conjunto de imágenes. De forma predeterminada, un conjunto contiene 25 imágenes. También puede utilizar los parámetros limit y marker para paginar a través de imágenes manualmente y especificar el número de imágenes que se pueden devolver.

El parámetro first en la respuesta indica la URL de la primera página de imágenes, y el parámetro next indica la URL de la siguiente página de imágenes. Cuando se consulta la última página de imágenes, no hay ningún parámetro next.

URI

GET /v2/images

  • 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.
  • Si necesita la API de la versión OpenStack de Queens, el encabezado de solicitud debe contener X-Api-Version. Si el valor de X-Api-Version es cualquier letra después de M en Alphabet, se devuelve la API de la versión de Queens. Si el valor es M o una letra anterior a M, se devuelve la API de la versión Mitaka.
Tabla 1 enumera los parámetros.
Tabla 1 Descripción del parámetro

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.

protected

No

Boolean

Especifica si la imagen está protegida. El valor es 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 inquilinos. Los valores disponibles incluyen:

  • public: imagen pública
  • private: imagen privada
  • shared: imagen compartida

owner

No

String

Especifica el inquilino 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.

container_format

No

String

Especifica el tipo de contenedor. El valor predeterminado es bare.

disk_format

No

String

Especifica el formato de imagen. El valor puede ser vhd, raw, zvhd, o qcow2. El valor predeterminado es vhd.

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 ECS especificaciones. Generalmente, el valor es 0.

min_disk

No

Integer

Especifica el espacio mínimo en disco (GB) necesario para ejecutar la imagen. El valor varía de 40 GB a 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, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, o EulerOS.

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 van a consultar. El valor es un entero. De forma predeterminada, se pueden consultar 25 imágenes.

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 create_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. El valor puede ser Linux, Windows, o 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", las etiquetas de consulta con "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.

__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. Para obtener más información sobre los sistemas operativos de imágenes compatibles con los ECS acelerados por GPU, consulte Tabla 2. 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 HANA ECSs 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 ECS con la InfiniBand NIC 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.

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 Operator:UTC time.

Se admiten los siguientes operadores:

  • gt: mayor que
  • gte: mayor o igual a
  • lt: menos de
  • lte: inferior o igual a
  • eq: igual a
  • neq: no es igual a

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 create_at en 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 Operator:UTC time.

Se admiten los siguientes operadores:

  • gt: mayor que
  • gte: mayor o igual a
  • lt: menos de
  • lte: inferior o igual a
  • eq: igual a
  • neq: no es igual a

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 en lt:2018-10-28T10:00:00Z.

Common Query Methods

  • Public images

    GET /v2/images?__imagetype=gold&visibility=public&protected=true

  • Private images

    GET /v2/images?owner={project_id}

  • Available shared images

    GET /v2/images?member_status=accepted&visibility=shared&__imagetype=shared

  • Rejected images

    GET /v2/images?member_status=rejected&visibility=shared&__imagetype=shared

  • Unaccepted images

    GET /v2/images?member_status=pending&visibility=shared&__imagetype=shared

Solicitud

  • Parámetros de solicitud

    Ninguno

  • Ejemplo de solicitud 
    GET https://{Endpoint}/v2/images

Respuesta

  • Parámetros de respuesta

    Parámetro

    Type

    Description

    first

    String

    Especifica la dirección URL de la primera página de las imágenes.

    next

    String

    Especifica la dirección URL de la página siguiente de las imágenes. Cuando se consulta la última página de imágenes, no hay ningún parámetro next.

    schema

    String

    Especifica la dirección URL del esquema que describe una lista de imágenes.

    images

    Array of objects

    Especifica el tipo de recurso.

    Para más detalles, consulte Tabla 2.
    Tabla 2 Descripción de la estructura de datos del campo de imágenes

    Parámetro

    Tipo

    Descripción

    __backup_id

    String

    Especifica el ID de copia de respaldo. Si la imagen se crea a partir de una copia de respaldo, establezca el valor en el ID de copia de respaldo. De lo contrario, este parámetro no es necesario.

    __data_origin

    String

    Especifica el origen de la imagen. Si la imagen es una imagen pública, el valor se deja vacío.

    __description

    String

    Especifica la descripción de la imagen.

    __image_location

    String

    Especifica la ubicación en la que se almacena la imagen.

    __image_size

    String

    Especifica el tamaño (bytes) del archivo de imagen. El valor es mayor que 0.

    __image_source_type

    String

    Especifica el almacenamiento backend de la imagen. Actualmente solo es compatible con UDS.

    __is_config_init

    String

    Especifica si se ha completado la configuración inicial. El valor puede ser true o false.

    __isregistered

    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.

    __lazyloading

    String

    Especifica si la imagen admite la carga lenta.

    __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, el valor se deja vacío.

    __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.

    protected

    Boolean

    Especifica si la imagen está protegida. Establezca el valor de true cuando consulte imágenes públicas. Este parámetro es opcional cuando consulta imágenes privadas.

    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 ECS imagen (imagen de disco del sistema), el valor es de FusionCompute.
    • Para una imagen de disco de datos, el valor es de DataImage.
    • Para una BMS imagen, el valor es Ironic.
    • Para una imagen ISO, el valor es de IsoImage.

    virtual_size

    Integer

    Este parámetro no está disponible actualmente.

    visibility

    String

    Especifica si la imagen está disponible para otros inquilinos. El valor puede ser uno de los siguientes:

    • public: imagen pública
    • private: imagen privada
    • shared: imagen compartida

    owner

    String

    Especifica el inquilino al que pertenece la imagen.

    id

    String

    Especifica el ID 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.

    name

    String

    Especifica el nombre de la imagen. Para una descripción detallada, consulte Atributos de imagen.

    container_format

    String

    Especifica el tipo de contenedor.

    disk_format

    String

    Especifica el formato de imagen. El valor puede ser vhd, raw, zvhd, o qcow2. El valor predeterminado es vhd.

    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 ECS especificaciones. Generalmente, el valor es 0.

    max_ram

    String

    Especifica la memoria máxima (MB) de la imagen.

    min_disk

    Integer

    Especifica el espacio mínimo en disco (GB) necesario para ejecutar la imagen. El valor varía de 40 GB a 255 GB.

    __os_bit

    String

    Especifica la arquitectura del sistema operativo, de 32 bits o 64 bits.

    __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.

    __platform

    String

    Especifica el tipo de plataforma de imagen. El valor puede ser Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, o EulerOS.

    schema

    String

    Especifica el esquema de imagen.

    self

    String

    Especifica la dirección URL de la imagen.

    size

    Integer

    Este parámetro no está disponible actualmente.

    __os_type

    String

    Especifica el tipo de sistema operativo de imagen. El valor puede ser Linux, Windows, o Other.

    __os_version

    String

    Especifica la versión del sistema operativo.

    tags

    Array of strings

    Especifica las etiquetas de la imagen, a través de las cuales puede gestionar imágenes privadas a su manera.

    __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. Para obtener más información sobre los sistemas operativos de imágenes compatibles con los ECS acelerados por GPU, consulte Tabla 2. 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 HANA ECSs 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 ECS con la InfiniBand NIC 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.

    __productcode

    String

    Especifica el ID de producto de una imagen de Marketplace.

    __root_origin

    String

    Especifica que la imagen se crea a partir de un archivo de imagen externo. Valor: file

    __sequence_num

    String

    Especifica el ECS número de ranura de disco del sistema correspondiente a 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 sólo es válido para imágenes de disco del sistema ECS.

    __is_offshelved

    String

    Especifica si se ha deshabilitado la imagen de Marketplace.

    • true: La imagen ha sido deshabilitada.
    • false: La imagen no ha sido deshabilitada.

    created_at

    String

    Especifica la hora en que se creó la imagen. El valor está en formato UTC.

    updated_at

    String

    Especifica la hora a la que se actualizó la imagen. El valor está en formato UTC.

    active_at

    String

    Especifica la hora en que el estado de la imagen se active.

    checksum

    String

    Este parámetro no está disponible actualmente.

    hw_firmware_type

    String

    Especifica el ECS modo de arranque. Los valores disponibles incluyen:

    • bios indica el modo de arranque del BIOS.
    • uefi indica el modo de arranque UEFI.

    file

    String

    Especifica la dirección URL para cargar y descargar el archivo de imagen.

    enterprise_project_id

    String

    Especifica el proyecto de empresa al que pertenece la imagen.

    • Si el valor es 0 o se deja en blanco, la imagen pertenece al proyecto de empresa predeterminado.
    • Si el valor es un UUID, la imagen pertenece al proyecto de empresa correspondiente al UUID.

    __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.

    __system__cmkid

    String

    Especifica el ID de la clave utilizada para cifrar la imagen.

    hw_vif_multiqueue_enabled

    String

    Especifica si la imagen admite varias colas NIC. El valor puede ser true o false.
  • Ejemplo de respuesta 
    STATUS CODE 200
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
    		 
    {
  "schema": "/v2/schemas/images",
  "next": "/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2",
  "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",
      "__support_kvm_fpga_type": "VU9P",
      "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"
    },
    {
      "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",
      "__support_kvm_fpga_type": "VU9P_COMMON",
      "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"
    }
  ],
  "first": "/v2/images?__isregistered=true&__imagetype=gold&limit=2"
}

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.