Last updated: 2020-10-22 16:49:23

1. API Description

Domain name for API request:

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:

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request 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. For more information, please see the list of regions supported by the product.
ImageName Yes String Image name
InstanceId No String Instance ID 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 Specified data disk ID included in the full image created from the instance.
SnapshotIds.N No Array of String Specified snapshot ID used to create an image. A system disk snapshot must be included. It cannot be passed together with InstanceId.
DryRun No Boolean Success status of this 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 the instance is running, perform a soft shutdown. If the soft shutdown fails, the task will end (default semantics).

Input Example

&<common request parameters>

Output Example

  "Response": {
    "ImageId": "img-0yc6rie8",
    "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.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

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.
InvalidAccount.InsufficientBalance Insufficient account balance.
InvalidImageName.Duplicate The specified image name already exists.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.NotFound No instance found.
InvalidParameter.DataDiskIdContainsRootDisk RootDisk ID 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.SpecifyOneParameter At least one of the multiple parameters must be passed in.
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.
InvalidParameterConflict The two specified parameters conflict. An EIP can only be bound to the instance or the specified private IP of the specified ENI.
InvalidParameterValue.TooLarge The parameter value exceeds the maximum limit.
MutexOperation.TaskRunning An identical job is running.
OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
ResourceInsufficient.CloudDiskUnavailable The parameters of cloud disk do not meet the specification.
UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
UnsupportedOperation.NotSupportInstanceImage The instance does not support this operation.
UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback