Updated on 2024-06-25 GMT+08:00

Image Management

Permission

API

Action

IAM Project

Enterprise Project

Querying Images

GET /v2/cloudimages

ims:images:list

NOTE:

Shared image query is only supported in IAM projects.

Querying Supported Image OSs

GET /v1/cloudimages/os_version

ims:images:list

×

Updating Image Information

PATCH /v2/cloudimages/{image_id}

  • ims:images:update
  • ims:serverImages:create (only for migration to enterprise projects)

Creating an Image

POST /v2/cloudimages/action

NOTE:

Before creating an image using an external image file, ensure that you have the Tenant Administrator permission for OBS.

ims:serverImages:create

Importing an Image File Quickly

POST /v2/cloudimages/quickimport/action

NOTE:

Before quickly importing an image file, ensure that you have the Tenant Administrator permission for OBS.

  • ims:serverImages:create (required only for quickly importing system disk images)
  • ims:dataImages:create (required only for quickly importing data disk images)

Creating a Data Disk Image Using an External Image File

POST /v1/cloudimages/dataimages/action

NOTE:

Before using an external image file, ensure that you have the Tenant Administrator permission for OBS.

ims:dataImages:create

Creating a Full-ECS Image

POST /v1/cloudimages/wholeimages/action

NOTE:

Before creating a full-ECS image, ensure that you have the CSBS Administrator permission of the CSBS service or the CBR Admin permission of the CBR service.

ims:wholeImages:create

Registering an Image

PUT /v1/cloudimages/{image_id}/upload

NOTE:
  • Before registering an image file, ensure that you have the Tenant Administrator permission for OBS.
  • You have the permissions to use enterprise projects when you register an image only if you select the default enterprise project.

ims:images:upload

Exporting an Image

POST /v1/cloudimages/{image_id}/file

NOTE:

Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.

ims:images:export

Querying Images (Native OpenStack API)

GET /v2/images

ims:images:list

x

Querying Image Details (Native OpenStack API)

GET /v2/images/{image_id}

ims:images:get

Updating Image Information (Native OpenStack API)

PATCH /v2/images/{image_id}

ims:images:update

Deleting an Image (Native OpenStack API)

DELETE /v2/images/{image_id}

ims:images:delete

Creating Image Metadata (Native OpenStack API)

POST /v2/images

ims:images:create

x

Uploading an Image (Native OpenStack API)

PUT /v2/images/{image_id}/file

  • ims:images:get
  • ims:images:update
  • ims:images:upload

x

Querying the API Version (Native OpenStack API)

GET /

N/A

x

Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)

GET /v1.1/images/detail

ims:images:list

x

Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)

HEAD /v1/images/{image_id}

ims:images:get

x

Deleting an Image (Native OpenStack API V1.1, Abandoned and Not Recommended)

DELETE /v1.1/images/{image_id}

ims:images:delete

x