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)> Actualización de la información de imagen (Native OpenStack API)

Actualización más reciente 2022-11-07 GMT+08:00

Ver PDF

Actualización de la información de imagen (Native OpenStack API)

Función

Esta API se utiliza para modificar la información de la imagen.

Restricciones

Solo se pueden modificar los atributos personalizados, el nombre de la imagen y la descripción de la imagen.

URI

PATCH /v2/images/{image_id}

Tabla 1 enumera los parámetros.

**Tabla 1** Descripción del parámetro
Parámetro	Obligatorio	Tipo	Descripción
image_id	Sí	String	Especifica el ID de imagen. Para obtener más información sobre cómo obtener el ID de imagen, consulte Consulta de imágenes.

Solicitud

Parámetros de solicitud

Glance tiene dos métodos para actualizar la información de la imagen. El método se especifica mediante Content-Type en el encabezado HTTP. application/openstack-images-v2.0-json-patch y application/openstack-images-v2.1-json-patch son compatibles. Los tipos de contenido sólo difieren en el formato del cuerpo del mensaje de solicitud.

**Tabla 2** cuerpo del mensaje de solicitud v2.1
Parámetro	Obligatorio	Tipo	Descripción
[Array]	Sí	Array of objects	Para más detalles, consulte Tabla 3.

**Tabla 3** Descripción de la estructura de datos del campo [Array]
Parámetro	Tipo	Obligatorio	Descripción
op	String	Sí	Indica el tipo de operación de actualización, incluida la sustitución, adición y eliminación de un atributo. El valor puede replace, add, o remove.
path	String	Sí	Indica el nombre del atributo de destino. Para replace y remove, el valor solo puede ser un atributo existente de la imagen. Para add, el valor puede ser un atributo existente o nuevo. Si el valor es un atributo existente, add tiene el mismo efecto que replace. Si el valor es un atributo nuevo, se realiza la operación de add. Agregue una barra diagonal (/) antes del nombre del atributo.
value	String	No	Indica el valor del atributo que se va a actualizar o agregar. Obligatorio para replace y add, y no para remove

**Tabla 4** cuerpo del mensaje de solicitud v2.0
Parámetro	Obligatorio	Tipo	Descripción
[Array]	Sí	Array of objects	Para más detalles, consulte Tabla 5.

**Tabla 5** Descripción de la estructura de datos del campo [Array]
Parámetro	Tipo	Obligatorio	Descripción
replace	String	Mandatory for any of the three values	Indica que se reemplazará un atributo image. El valor es el atributo que se va a reemplazar y se debe agregar una barra diagonal (/) delante del nombre del atributo.
add	String		Indica que se agregará un atributo image. El valor es el atributo que se va a agregar y se debe agregar una barra diagonal (/) delante del nombre del atributo.
remove	String		Indica que se eliminará un atributo de imagen. El valor es el atributo que se va a eliminar y se debe agregar una barra diagonal (/) delante del nombre del atributo.
value	String	Obligatorio para replace y add, y no para remove	Indica el valor del atributo que se va a actualizar o agregar. Para una descripción detallada, consulte Atributos de imagen.

Ejemplo de solicitud

PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00

v2.1 cuerpo de la solicitud

        
             "Content-Type:application/openstack-images-v2.1-json-patch"   
[
     {
         "op": "replace",
         "path": "/name",
         "value": "test01"
     }
]

cuerpo de la solicitud v2.0

        
             "Content-Type:application/openstack-images-v2.0-json-patch"
[
     {
         "replace": "/name",
         "value": "test01"       
     }
]

Respuesta

Parámetros de respuesta

Parámetro	Tipo	Descripción
file	String	Especifica la dirección URL para cargar y descargar el archivo de imagen.
owner	String	Especifica el inquilino 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: 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 inquilinos. El valor puede ser: private: imagen privada public: imagen pública shared: imagen compartida
name	String	Especifica el nombre de la imagen. Para 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 ECS especificaciones. El valor predeterminado es 0.
max_ram	String	Especifica la memoria máxima (MB) de la imagen. El valor del parámetro depende de las ECS especificaciones y no está configurado de forma predeterminada.
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	Especifica la descripción de la imagen. Para una descripción detallada, consulte Atributos de imagen.
disk_format	String	Especifica el formato de imagen. El valor puede ser vhd, zvhd, zvhd2, raw, iso, o qcow2. El valor predeterminado es vhd.
__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, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, o EulerOS.
__os_type	String	Especifica el tipo de sistema operativo. El valor puede ser Linux, Windows, o Other.
__system__cmkid	String	Especifica el ID de la clave utilizada para cifrar 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.
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.
__image_source_type	String	Especifica el almacenamiento backend de la imagen. Actualmente solo es compatible con 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.
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, el valor se deja vacío.
__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.
__productcode	String	Especifica el ID de producto de una imagen de Marketplace.
__image_size	String	Especifica el tamaño (bytes) del archivo de imagen. El valor debe ser mayor que 0.
__data_origin	String	Especifica el origen de la imagen. Si la imagen es una imagen pública, el valor se deja vacío.
__root_origin	String	Especifica que la imagen se crea a partir de un archivo de imagen externo. Valor: file
__lazyloading	String	Especifica si la imagen admite la carga lenta. El valor puede ser true o false.
active_at	String	Especifica la hora en que el estado de la imagen se active.
__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.
__account_code	String	Especifica el identificador de carga de la imagen.
hw_firmware_type	String	Especifica el ECS modo de arranque. El valor puede ser: bios indica el modo de arranque del BIOS. Este valor se utilizará por error si este parámetro no existe en la respuesta. uefi indica el modo de arranque UEFI.
hw_vif_multiqueue_enabled	String	Especifica si la imagen admite varias colas NIC. El valor puede ser true o false.
__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 se puede utilizar para crear 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 los sistemas operativos compatibles, consulte OS compatibles con diferentes tipos de ECSs..
__support_diskintensive	String	Especifica si la imagen se puede utilizar para crear 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 se puede utilizar para crear 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 parámetro 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 parámetro 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 parámetro 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 parámetro no puede coexistir con __support_xen.
__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.
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. Para obtener más información acerca de los proyectos de empresa, consulte Centro de empresa.
__sequence_num	String	Especifica el ECS número de ranura de disco del sistema correspondiente a la imagen. Este parámetro no está disponible actualmente.
__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.
__image_location	String	Especifica la ubicación en la que se almacena la imagen.
__is_config_init	String	Especifica si se ha completado la configuración inicial. El valor puede ser true o false.
__support_amd	String	Especifica si la imagen utiliza la arquitectura x86 de AMD. 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 monitorización del host está configurado para la imagen. Ejemplo: "__support_agent_list": "hss,ces" NOTA: Si la respuesta no contiene este campo, el HSS y los agentes de supervisión del host no están configurados para la imagen.

Ejemplo de respuesta

STATUS CODE 200

      
       
         
         
           {  
    "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file",  
    "owner": "0b1e494e2660441a957313163095fe5c",  
    "id": "33ad552d-1149-471c-8190-ff6776174a00",  
    "size": 2,  
    "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00",  
    "schema": "/v2/schemas/image",  
    "status": "active",  
    "tags": [],  
    "visibility": "private",  
    "name": "ims_test",  
    "checksum": "99914b932bd37a50b983c5e7c90ae93b",  
    "protected": false,  
    "container_format": "bare",  
    "min_ram": 0,  
    "updated_at": "2015-12-08T02:30:49Z",  
    "__os_bit": "64",  
    "__os_version": "Ubuntu 14.04 server 64bit",  
    "__description": "ims test",  
    "disk_format": "vhd",  
    "__isregistered": "true",  
    "__platform": "Ubuntu",  
    "__os_type": "Linux",  
    "min_disk": 40,  
    "virtual_env_type": "FusionCompute",  
    "__image_source_type": "uds",  
    "__imagetype": "private",  
    "created_at": "2015-12-04T09:45:33Z",  
    "virtual_size": 0,  
    "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00",  
    "__backup_id": "",  
    "__productcode": "",  
    "__image_size": "449261568",  
    "__data_origin": null,
    "hw_firmware_type":"bios"
}

          

        

      
     

Valores devueltos

Normal
200

Anormal

Valor devuelto	Descripción
400 Bad Request	Error de solicitud. Para más detalles, 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.