tencent cloud



Last updated: 2022-06-20 15:51:56

1. API Description

Domain name for API request: cvm.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.

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 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.

3. Output Parameters

Parameter Name Type Description
TaskId Integer ID of the image export task
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Exporting custom images

Input Example

Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportImages
<Common request parameters>

    "ImageIds": [
    "BucketName": "test-bucket-AppId"

Output Example

  "Response": {
    "RequestId": "7995cb6f-0018-4286-a4d4-b6301b962d9e",
    "TaskId": 105591590

5. Developer Resources


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
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.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.InvalidImageState The image has another ongoing task. Please check and try again later.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the 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.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.SharedImageExportUnsupported Shared images cannot be exported.
UnsupportedOperation.WindowsImageExportUnsupported Windows images cannot be exported.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support