Creating a Full-ECS Image

Function

This API is used to create a full-ECS image from an ECS or a Cloud Server Backup Service (CSBS) backup. The API is an asynchronous one. If it is successfully called, the cloud system receives the request to create a full-ECS image. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.

Constraints (Creating a Full-ECS Image Using an ECS)

• When creating a full-ECS image from an ECS, ensure that the ECS has been properly configured, or the image creation may fail.
• A Windows ECS used to create a full-ECS image cannot have a spanned volume, or data may be lost when ECSs are created from that image.
• A Linux ECS used to create a full-ECS image cannot have a disk group or logical disk that contains multiple physical disks, or data may be lost when ECSs are created from that image.
• An ECS used to create a full-ECS image cannot contain a Dedicated Storage Service disk.
• A full-ECS image cannot be exported, replicated, or shared.
• When creating a full-ECS image from a Windows ECS, you need to change the SAN policy of the ECS to OnlineAll. Otherwise, EVS disks attached to the ECSs created from the image may be offline.

  Windows has three types of SAN policies: OnlineAll, OfflineShared, and OfflineInternal.

  Table 1 SAN policies in Windows

  Type	Description
  OnlineAll	All newly detected disks are automatically brought online.
  OfflineShared	All disks on sharable buses, such as iSCSI and FC, are left offline by default, while disks on non-sharable buses are kept online.
  OfflineInternal	All newly detected disks are left offline.

  1. Execute cmd.exe and run the following command to query the current SAN policy of the ECS:

     diskpart

  2. Run the following command to view the SAN policy of the ECS:
     san

     • If the SAN policy is OnlineAll, run the exit command to exit DiskPart.
     • If the SAN policy is not OnlineAll, go to 3.
  3. Run the following command to change the SAN policy of the ECS to OnlineAll:

     san policy=onlineall

Constraints (Creating a Full-ECS Image Using a CSBS Backup)

• When creating a full-ECS image from a CSBS backup, ensure that the source ECS of the CSBS backup has been properly configured, or the image creation may fail.
• If an ECS is in Stopped state, do not start it when you are using it to create a full-ECS image.
• A CSBS backup used to create a full-ECS image cannot have shared disks.
• Only an available CSBS backup can be used to create a full-ECS image. A CSBS backup can be used to create only one full-ECS image.
• A full-ECS image cannot be exported, replicated, or shared.

URI

POST /v1/cloudimages/wholeimages/action

Request

• Parameters for creating a full-ECS image using an ECS

  Parameter	Mandatory	Type	Description
  name	Yes	String	Specifies the image name. For detailed description, see Image Attributes.
  description	No	String	Provides supplementary information about the image. For detailed description, see Image Attributes.
  tags	No	Array of strings	Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.
  image_tags	No	Array of objects	Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.
  instance_id	Yes	String	Specifies the ECS ID. This parameter is required when an ECS is used to create a full-ECS image. To obtain the ECS ID, perform the following operations: Log in to management console. Under Computing, click Elastic Cloud Server. In the ECS list, click the name of the ECS and view its ID.
  max_ram	No	Integer	Specifies the maximum memory of the image in the unit of MB. This parameter is not configured by default.
  min_ram	No	Integer	Specifies the minimum memory of the image in the unit of MB. The default value is 0.

• Parameters in the request body when a CSBS backup is used to create a full-ECS image

  Parameter	Mandatory	Type	Description
  name	Yes	String	Specifies the image name. For detailed description, see Image Attributes.
  description	No	String	Provides supplementary information about the image. For detailed description, see Image Attributes.
  tags	No	Array of strings	Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.
  image_tags	No	Array of objects	Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.
  backup_id	Yes	String	Specifies the CSBS backup ID. To obtain the CSBS backup ID, perform the following operations: Log in to the management console. Under Storage, click Cloud Server Backup Service. In the backup list, expand details of the backup to obtain its ID.
  max_ram	No	Integer	Specifies the maximum memory of the image in the unit of MB. This parameter is not configured by default.
  min_ram	No	Integer	Specifies the minimum memory of the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

Example Request

• Creating a full-ECS image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)

  1 2 3 4 5 6 7 8 9 10 11

  POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "instance_whole_image", "description": "creating an image from an ECS", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }

• Creating a full-ECS image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)

  1 2 3 4 5 6 7

  POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "instance_whole_image", "description": "creating an image from an ECS", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }

• Creating a full-ECS image with parameter tags using aCSBS backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)

  1 2 3 4 5 6 7 8 9 10 11

  POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "backup_whole_image", "description": "Creating a full-ECS image from a CSBS backup", "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }

• Creating a full-ECS image with parameter image_tags using aCSBS backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)

  1 2 3 4 5 6 7

  POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "backup_whole_image", "description": "Creating a full-ECS image from a CSBS backup", "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }

Response

• Response parameters

  Parameter	Type	Description
  job_id	String	Specifies the asynchronous job ID. For details, see Querying the Status of an Asynchronous Job.

• Example response

  STATUS CODE 200

  1 2 3

  { "job_id": "4010a32b5f909853015f90aaa24b0015" }

Returned Values

• Normal

  200

• Abnormal

  Returned Value	Description
  400 Bad Request	Request error. For details about the returned error code, see Error Codes.
  401 Unauthorized	Authentication failed.
  403 Forbidden	You do not have the rights to perform the operation.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	The service is unavailable.