Consulta de etiquetas
Función
Esta API se utiliza para consultar etiquetas de imagen utilizando criterios de búsqueda y mostrarlas en una lista.
URI
GET /v1/cloudimages/tags{?__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}

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.
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:
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:
|
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:
|
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:
|
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, 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 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:
|
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 parámetro 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 parámetro 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 parámetro 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 parámetro 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.
|
enterprise_project_id |
No |
String |
Especifica el proyecto de empresa al que pertenecen las imágenes que se van a consultar.
|
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:
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:
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:
|
Solicitud
Parámetros de solicitud
Ninguna
Ejemplo de solicitud
Consulta de etiquetas de imagen
GET https://{Endpoint}/v1/cloudimages/tags?limit=5&page=1
Respuesta
- Parámetros de respuesta
Parámetro
Tipo
Descripción
tags
Array of strings
Muestra las etiquetas.
- Ejemplo de respuesta.
STATUS CODE 200
1 2 3 4 5 6 7 8 9
{ "tags": [ "jjjj.11111", "uuuu.22222", "234.4", "test", "image" ] }
En la nueva especificación, los signos iguales se utilizan como separadores.
Valores devueltos
- Normal
- 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.