产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to export custom images to the specified COS bucket.
A maximum of 20 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: ExportImages. |
| 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. |
| BucketName | Yes | String | COS bucket name |
| ImageIds.N | No | Array of String | List of image IDs |
| ExportFormat | No | String | Format of the exported image file. Valid values: RAW, QCOW2, VHD and VMDK. Default value: RAW. |
| FileNamePrefixList.N | No | Array of String | Prefix list of the name of exported files |
| OnlyExportRootDisk | No | Boolean | Whether to export only the system disk |
| DryRun | No | Boolean | Check whether the image can be exported |
| RoleName | No | String | Role name (Default: CVM_QcsRole). Before exporting the images, make sure the role exists, and it has write permission to COS. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | ID of the image export task |
| CosPaths | Array of String | List of COS filenames of the exported images |
| 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 export custom images.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportImages
<Common request parameters>
{
"ImageIds": [
"img-72n9mi0y"
],
"BucketName": "test-bucket-AppId"
}{
"Response": {
"RequestId": "7995cb6f-0018-4286-a4d4-b6301b962d9e",
"TaskId": 105591590,
"CosPaths": [
"/img-pq5pau1w_system_snap-fiux4bof.raw"
]
}
}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 |
|---|---|
| AuthFailure.CamRoleNameAuthenticateFailed | Role name authentication failed. |
| InvalidImageId.Malformed | Invalid image ID format. |
| InvalidImageId.NotFound | The image cannot be found. |
| InvalidParameter.ImageIdsSnapshotIdsMustOne | Either ImageIds or SnapshotIds must be specified. |
| InvalidParameter.SnapshotNotFound | The specified snapshot does not exist. |
| InvalidParameterValue.BucketNotFound | The bucket does not exist. |
| InvalidParameterValue.InvalidAppIdFormat | Invalid AppID |
| InvalidParameterValue.InvalidBucketPermissionForExport | You don’t have the write permission to the bucket. |
| InvalidParameterValue.InvalidFileNamePrefixList | The length of FileNamePrefixList does not match ImageIds or SnapshotIds. |
| InvalidParameterValue.InvalidImageId | The image does not support this operation. |
| InvalidParameterValue.InvalidImageOsName | The operating system of the specified image is not available in the current region. |
| InvalidParameterValue.InvalidImageState | The image has another ongoing task. Please check and try again later. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidParameterValue.TooLarge | The parameter value exceeds the maximum limit. |
| LimitExceeded.ExportImageTaskLimitExceeded | The number of image export tasks in progress reached the upper limit. Please try again after the running tasks are completed. |
| UnsupportedOperation.EncryptedImagesNotSupported | Encrypted images are not supported. |
| UnsupportedOperation.ImageTooLargeExportUnsupported | Failed to export the image: The image is too large. |
| UnsupportedOperation.MarketImageExportUnsupported | The custom images created with the market images cannot be exported. |
| UnsupportedOperation.PublicImageExportUnsupported | Public images and market images cannot be exported. |
| UnsupportedOperation.RedHatImageExportUnsupported | The RedHat image cannot be exported. |
| UnsupportedOperation.SharedImageExportUnsupported | Shared images cannot be exported. |
| UnsupportedOperation.WindowsImageExportUnsupported | Windows images cannot be exported. |
文档反馈