Creating an Image Using an ECS¶

Function¶

This API is used to create an image using an ECS. After the creation, you can use this image to create ECSs.

Images created using an ECS are stored on storage nodes as snapshots.

Note

This API is a native OpenStack API that is not applicable to the images on the cloud platform.

To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.

Constraints¶

An ECS in the error state cannot be used to create an image.
If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
The image created using an ECS cannot be used to create data disks.
The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.

URI¶

POST /v2.1/{project_id}/servers/{server_id}/action

POST /v2/{project_id}/servers/{server_id}/action

Table 1 describes the parameters in the URI.

**Table 1** Parameter description¶
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.
server_id	Yes	Specifies the ECS ID.

Request¶

Table 2 describes the request parameters.

**Table 2** Request parameters¶
Parameter	Mandatory	Type	Description
createImage	Yes	Object	Specifies the image created using ECS. For details, see Table 3.

**Table 3** **createImage** field description¶
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the image name with a length greater than 0 bytes and less than 243 bytes.
metadata	No	Object	Specifies the image attribute with a length greater than 0 bytes and less than 255 bytes.

Response¶

Parameter	Mandatory	Type	Description
Location	Yes	String	Specifies the local URL of the image, which is returned in the request header. This parameter is not supported in microversion 2.44 and later.
image_id	Yes	String	Specifies the image UUID. This parameter is supported in microversion 2.45 and later.

Parameter

Mandatory

Type

Description

Location

Yes

String

Specifies the local URL of the image, which is returned in the request header.

This parameter is not supported in microversion 2.44 and later.

image_id

Yes

String

Specifies the image UUID.

This parameter is supported in microversion 2.45 and later.

Example Request¶

Use a specified ECS to create a private image named new-image-name.

POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action

{
   "createImage" : {
        "name" : "new-image-name",
        "metadata": {
            "ImageType": "Gold",
            "ImageVersion": "2.0"
        }
    }
}

Example Response¶

None

Returned Values¶

See Returned Values for General Requests.

last updated: 2024-12-17 08:54 UTC - commit: 60d73b5e88a7b9e2d4d3346634d7fac6006f7365