Updating Image Information

Scenario

Image attributes can be modified to update image information.

Note

• Only the name and description of private images can be changed.

• The token obtained from Identity and Access Management (IAM) is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.

Involved APIs

If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header of the IMS API when making an API call.

• IAM API used to obtain the token

  URI format: POST https://IAM endpoint/v3/auth/tokens

• IMS API used to update image information (Native OpenStack API)

  URI format: PATCH https://IMS endpoint/v2/images/Image ID

Procedure

1. Obtain the token.

2. Send PATCH https://IMS endpoint/v2/cloudimages/Image ID.

3. Specify the following parameters in the request body:

   Parameter	Mandatory	Type	Description
   op	Yes	String	Specifies the operation. The value can be add, replace, or remove.
   path	Yes	String	Specifies the name of the attribute to be modified. A slash (/) needs to be added in front of it. You can modify the following attributes: name: image name __description: image description __support_xen: Xen is supported. __support_largememory: Ultra-large memory is supported. __support_diskintensive: Intensive storage is supported. __support_highperformance: High-performance computing (HPC) is supported. __support_xen_gpu_type: GPU-accelerated ECSs that use Xen for virtualization are supported. __support_xen_hana: HANA ECSs that use Xen for virtualization are supported. min_ram: minimum memory hw_vif_multiqueue_enabled: The NIC multi-queue feature is supported. hw_firmware_type: boot mode. The value can be bios or uefi. You can add or delete extended attributes.
   value	Yes	Determined by the attribute value	Specifies the new value of the attribute.

   Example request:

   [
       {
           "op": "replace",
           "path": "/name",
           "value": "ims_test"
       }
   ]
   

4. Refer to "Updating Image Information" in the Image Management Service API Reference for details about the request response parameters.

   For details about status codes for request errors, see Status Codes.

last updated: 2024-11-13 15:15 UTC - commit: b636e55e81d9b75131fd075994c6c3e2fb2c5042