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
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. Click here to learn more about Sysprep. |
| 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 |
| 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. |
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).
GET https://cvm.tencentcloudapi.com/?Action=CreateImage
&InstanceId=ins-6pb6lrmy
&ImageName="name"
&<Common request parameters>{
"Response": {
"ImageId": "img-0yc6rie8",
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 data 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. |
| ResourceInUse | The resource is in use. |
| ResourceInsufficient.CloudDiskUnavailable | The parameters of cloud disk do not meet the specification. |
| ResourceUnavailable.SnapshotCreating | |
| UnsupportedOperation.InstanceStateRebooting | The instances are being restarted, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRescueMode | Instances in the rescue mode are not available for this operation. |
| 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.SpecialInstanceType | This special instance type does not support the operation. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
Was this page helpful?