CLI Command Reference

Querying the Progress of an Asynchronous Job

hcloud IMS ShowJobProgress

This is an extended API. It is used to query the progress of an asynchronous job.

Debug

Exporting an Image

hcloud IMS ExportImage

This is an extended API. It is used to export a private image to an OBS bucket.

Debug

Exporting an Image (New)

hcloud IMS ExportImageInSafeMode

This is an extended API. It is used to export a private image to an OBS bucket.

Debug

Querying Images

hcloud IMS ListImages

This API is used to query images using search criteria.

Debug

Updating an Image

hcloud IMS UpdateImage

This API is used to update image information. Only active images can be updated.

Debug

Creating a Data Disk Image Using an External Image File

hcloud IMS CreateDataImage

This API is used to create a data disk image from a data disk image file uploaded to an OBS bucket. This is an asynchronous API. A successful call only means the backend has received the request. To see if an image is created successfully, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Progress of an Asynchronous Job.

Debug

Creating a Data Disk Image from an External Image File (New)

hcloud IMS CreateDataImageInSafeMode

This API is used to create a data disk image from a data disk image file uploaded to an OBS bucket. This is an asynchronous API. A successful call only means the backend has received the request. To see if an image is created successfully, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Progress of an Asynchronous Job.

Debug

Creating an Image

hcloud IMS CreateImage

This API is used to create a private image. You can:

• Create a private image (system or data disk image) from a cloud server.
• Create a system disk image from an external image file uploaded to an OBS bucket.
• Create a system disk image from a data disk.

Debug

Creating an Image (New)

hcloud IMS CreateImageInSafeMode

This API is used to create a private image. You can:

• Create a private image (system or data disk image) from a cloud server.
• Create a system disk image from an external image file uploaded to an OBS bucket.
• Create a system disk image from a data disk.

Debug

Registering an Image

hcloud IMS RegisterImage

This API is used to register an image file as an uninitialized private image on the cloud platform.

Debug

Importing an Image File Quickly

hcloud IMS ImportImageQuick

This API is used to quickly create a private image from an oversized external image file that has been uploaded to an OBS bucket. Currently, only ZVHD2 and RAW image files can be imported quickly, and the size of such an image file cannot exceed 1 TB.

Debug

Importing an Image File Quickly (New)

hcloud IMS ImportImageQuickInSafeMode

This API is used to quickly create a private image from an oversized external image file that has been uploaded to an OBS bucket. Currently, only ZVHD2 and RAW image files can be imported quickly, and the size of such an image file cannot exceed 1 TB.

Debug

Creating a Full-ECS Image

hcloud IMS CreateWholeImage

This API is used to create a full-ECS image from an ECS or a Cloud Server Backup Service (CSBS) backup. This is an asynchronous API. A successful call only means the backend has received the request. To see if an image is created successfully, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Progress of an Asynchronous Job.

Debug

Querying Supported Image OSs

hcloud IMS ListOsVersions

This API is used to query compatible ECS OSs in the current region.

Debug

Adding Image Recipients

hcloud IMS BatchAddMembers

This is an extended API. It is used to share more than one image with multiple users.

Debug

Updating the Image Sharing Status of a Recipient

hcloud IMS BatchUpdateMembers

This is an extended API used to batch accept or reject images shared with a user.

Debug

Deleting Image Recipients

hcloud IMS BatchDeleteMembers

This is an extended API. It is used to stop sharing images.

Debug

Querying Details About an Image Recipient

hcloud IMS ShowImageMember

This API is used to query details about an image recipient.

Debug

Querying Image Recipients

hcloud IMS ListImageMembers

This API is used to query image recipients.

Debug

Replicating an Image Within a Region

hcloud IMS CopyImageInRegion

This is an extended API. It is used to replicate an image. When replicating an image, you can change the image attributes to meet the requirements of different scenarios.

Debug

Replicating an Image Within a Region (New)

hcloud IMS CopyImageInRegionInSafeMode

This is an extended API. It is used to replicate an image. When replicating an image, you can change the image attributes to meet the requirements of different scenarios.

Debug

Replicating an Image Across Regions

hcloud IMS CopyImageCrossRegion

This is an extended API. It is used to replicate a private image from one region to another. In the destination region, the replicated image can be used to create cloud servers identical to those in the source region. This allows you to migrate services between regions.

Debug

Querying Tags

hcloud IMS ListTags

This API is used to query image tags using search criteria.

Debug

Adding or Modifying a Tag

hcloud IMS CreateOrUpdateTags

This API is used to add or modify a custom tag for an image. You can classify images by custom tag.

Debug

Querying Images by Tag

hcloud IMS ListImageByTags

This API is used to filter or count images using tags or other conditions.

Debug

Querying All Image Tags

hcloud IMS ListImagesTags

This API is used to query all image tags of a tenant.

Debug

Querying Tags of an Image

hcloud IMS ListImageTags

This API is used to query all tags of a specified image.

Debug

Adding an Image Tag

hcloud IMS AddImageTag

This API is used to add or update a single tag for a specified image.

Debug

Adding or Deleting Image Tags in a Batch

hcloud IMS BatchAddOrDeleteTags

This API is used to add tags to, update tags of, or delete tags from an image in a batch.

Debug

Deleting an Image Tag

hcloud IMS DeleteImageTag

This API is used to delete a specified tag from an image.

Debug

Deleting Image Tags

hcloud IMS BatchDeleteTags

This API is used to batch delete tags from a specified image.

Debug

Querying Image Quotas

hcloud IMS ShowImageQuota

This is an extended API. It is used to query private image quotas of a tenant in the current region.

Debug

Querying Image Recipients (Native OpenStack API)

hcloud IMS GlanceListImageMembers

This API is used to query image recipients.

Debug

Adding an Image Recipient (Native OpenStack API)

hcloud IMS GlanceAddImageMember

This API is used to add the project ID of a tenant that an image is to be shared with.

Debug

Querying Details About an Image Recipient (Native OpenStack API)

hcloud IMS GlanceShowImageMember

This API is used to query details about an image recipient.

Debug

Updating the Image Sharing Status of a Recipient (Native OpenStack API)

hcloud IMS GlanceUpdateImageMember

This is an extended API. It is used to batch accept or reject images shared with a user.

Debug

Deleting an Image Recipient (Native OpenStack API)

hcloud IMS GlanceDeleteImageMember

This API is used to stop image sharing with a user.

Debug

Adding a Tag (Native OpenStack API)

hcloud IMS GlanceCreateTag

This API is used to add a custom tag to an image. You can classify images by custom tag.

Debug

Deleting a Tag (Native OpenStack API)

hcloud IMS GlanceDeleteTag

This API is used to delete a custom tag from a private image.

Debug

Querying an Image Schema (Native OpenStack API)

hcloud IMS GlanceShowImageSchemas

This API is used to query the image schema, which allows you to view image attributes and their data types.

Debug

Querying the Image Recipient List Schema (Native OpenStack API)

hcloud IMS GlanceListImageMemberSchemas

This API is used to query the image recipient list schema, which allows you to view image recipient attributes and their data types.

Debug

Querying the Image List Schema (Native OpenStack API)

hcloud IMS GlanceListImageSchemas

This API is used to query the image list schema, which allows you to view detailed information and the data structure of an image list.

Debug

Querying the Image Recipient Schema (Native OpenStack API)

hcloud IMS GlanceShowImageMemberSchemas

This API is used to query the image recipient schema, which allows you to view image recipient attributes and their data types.

Debug

Querying Images (Native OpenStack API)

hcloud IMS GlanceListImages

This API is used to obtain the image list.

Debug

Creating Image Metadata (Native OpenStack API)

hcloud IMS GlanceCreateImageMetadata

This API is used to create image metadata. After this API is called, only image metadata is created, and no actual image file is generated.

Debug

Querying Image Details (Native OpenStack API)

hcloud IMS GlanceShowImage

This API is used to query details about a public or private image.

Debug

Deleting an Image (Native OpenStack API)

hcloud IMS GlanceDeleteImage

This API is used to delete a private image. You can only delete your own private images.

Debug

Updating an Image (Native OpenStack API)

hcloud IMS GlanceUpdateImage

This API is used to modify image information.

Debug

Querying API Versions (Native OpenStack API)

hcloud IMS ListVersions

This API is used to query API versions, such as version compatibility and domain name information of APIs.

Debug

Querying an API Version (Native OpenStack API)

hcloud IMS ShowVersion

This API is used to query a specified API version, such as version compatibility and domain name information of an API.

Debug