产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
Domain name for API request: cvm.intl.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.
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 Params. The value used for this API: CreateImage. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ImageName | Yes | String | Image name. |
| InstanceId | No | String | ID of the instance from which an image will be created. This parameter is required when using instance to create an image. |
| ImageDescription | No | String | Image description. |
| ForcePoweroff | No | String | Whether to perform forced power-off operation to create an image. Valid values: Default value: false. Creating an image in the power-on state may result in some unbacked-up data, affecting data security. |
| Sysprep | No | String | Whether to enable Sysprep when creating a Windows image. Valid values: TRUE and FALSE; default value: FALSE.Click here to learn more about Sysprep. |
| DataDiskIds.N | No | Array of String | IDs of data disks included in the image. |
| 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 |
| TagSpecification.N | No | Array of TagSpecification | Tag description list. This parameter is used to bind a tag to a custom image. |
| ImageFamily | No | String | Image family |
| 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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).
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImage
<Common request parameters>
{
"InstanceId": "ins-6pb6lrmy",
"ImageName": "myImage"
}{
"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.InvalidAppIdFormat | Invalid AppID |
| InvalidParameterValue.InvalidImageFamily | Invalid format of image family name |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidParameterValue.PreheatNotSupportedInstanceType | Preheating is not supported on this model. |
| InvalidParameterValue.PreheatNotSupportedZone | Preheating is not supported in this availability zone. |
| InvalidParameterValue.PreheatUnavailableZones | The pre-warming region is unavailable. Please check if the pre-warming region is correct. |
| InvalidParameterValue.TagKeyNotFound | The specified tag does not exist |
| InvalidParameterValue.TagQuotaLimitExceeded | Tag quota limit exceeded. |
| InvalidParameterValue.TooLarge | The parameter value exceeds the maximum limit. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |
| LimitExceeded.PreheatImageSnapshotOutOfQuota | Reached the upper limit for preheating in this availability zone. Remove some snapshots first. |
| 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. |
| ResourceInUse.DiskRollbacking | The disk rollback is in progress. Please try again later. |
| ResourceInsufficient.CloudDiskUnavailable | The parameters of cloud disk do not meet the specification. |
| ResourceUnavailable.SnapshotCreating | The snapshot is being created. |
| UnsupportedOperation.EncryptedImagesNotSupported | Encrypted images are not supported. |
| UnsupportedOperation.InstanceReinstallFailed | The current instance is in a failed OS reinstallation state and does not support this operation. We recommend reinstalling the operating system again. Alternatively, you may terminate/return the instance or submit a support ticket. |
| UnsupportedOperation.InstanceStateEnterRescueMode | Instances are entering the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateEnterServiceLiveMigrate | The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported. |
| UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateFreezing | The operation is not supported for the frozen instances. |
| 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.InstanceStateServiceLiveMigrate | The instances are being migrated, and this operation is not supported. |
| UnsupportedOperation.InstanceStateStarting | The instance is starting up, 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.InvalidDiskFastRollback | Fast rollback is not supported. |
| UnsupportedOperation.NotSupportInstanceImage | The instance does not support this operation. |
| UnsupportedOperation.PreheatImage | Image preheating is not supported under your account. |
| 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. |
文档反馈