CreateImage

Last updated: 2019-12-05 20:39:00

PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to create a new image with the system disk of an instance. The image can be used to create new instances.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateImage
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter.
ImageName Yes String Image name
InstanceId No String The ID of the instance used to create an image
ImageDescription No String Image description
ForcePoweroff No String Whether to force shut down an instance to create an image when a soft shutdown fails
Sysprep No String Whether to enable Sysprep when creating a Windows image
DataDiskIds.N No Array of String The ID of the data disk used to create an image
SnapshotIds.N No Array of String The ID of the snapshot used to create an image. A system disk snapshot must be included.
DryRun No Boolean Verifies the validity of the request without affecting the resources involved.

3. Output Parameters

Parameter Name Type Description
ImageId String Image ID
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an image

This example shows you how to create an image from the instance “ins-6pb6lrmy”. If an instance is running, perform a soft shutdown. If the soft shutdown fails, the task will end.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=CreateImage
&InstanceId=ins-6pb6lrmy
&ImageName="name"
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
ImageQuotaLimitExceeded The image quota has been exceeded.
InvalidImageName.Duplicate The specified image name already exists.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.NotFound No instance found.
InvalidParameter.DataDiskIdContainsRootDisk RootDisk should not be passed to DataDiskIds.
InvalidParameter.DataDiskNotBelongSpecifiedInstance The specified data disk does not belong to the specified instance.
InvalidParameter.DuplicateSystemSnapshots Only one system disk snapshot can be included.
InvalidParameter.InstanceImageNotSupport This API does not support instance images.
InvalidParameter.InvalidDependence Invalid parameter dependency.
InvalidParameter.LocalDataDiskNotSupport Local disks cannot be used to create instance images.
InvalidParameter.SnapshotNotFound The specified snapshot does not exist.
InvalidParameter.SwapDiskNotSupport Swap disks are not supported.
InvalidParameter.SystemSnapshotNotFound The parameter does not contain system disk snapshot.
InvalidParameter.ValueTooLarge The length of parameter exceeds the limit.
MutexOperation.TaskRunning An identical job is running.