Tencent Cloud

ImportImage

最后更新时间：2024-10-22 19:33:23

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to import an image. The image imported can be used to create instances. Currently, this API supports RAW, VHD, QCOW2, and VMDK image formats.

A maximum of 10 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: ImportImage.
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.
Architecture	Yes	String	OS architecture of the image to be imported, `x86_64` or `i386`.
OsType	Yes	String	OS type of the image to be imported. You can call `DescribeImportImageOs` to obtain the list of supported operating systems.
OsVersion	Yes	String	OS version of the image to be imported. You can call `DescribeImportImageOs` to obtain the list of supported operating systems.
ImageUrl	Yes	String	Address on COS where the image to be imported is stored.
ImageName	Yes	String	Image name
ImageDescription	No	String	Image description
DryRun	No	Boolean	Dry run to check the parameters without performing the operation
Force	No	Boolean	Whether to force import the image. For more information, see Forcibly Import Image.
TagSpecification.N	No	Array of TagSpecification	Tag description list. This parameter is used to bind a tag to a custom image.
LicenseType	No	String	The license type used to activate the OS after importing an image. Valid values: `TencentCloud`: Tencent Cloud official license `BYOL`: Bring Your Own License
BootMode	No	String	Boot mode
ImageFamily	No	String	Image family

3. Output Parameters

Parameter Name	Type	Description
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.

4. Example

Example1 Importing an image

This example shows you how to import an image.

Input Example

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

{
    "ImageUrl": "http://111-1251233127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk",
    "ImageDescription": "sampleimage",
    "ImageName": "sample",
    "Architecture": "x86_64",
    "OsType": "CentOS",
    "OsVersion": "6"
}

Output Example

{
    "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.
InvalidImageName.Duplicate	The specified image name already exists.
InvalidImageOsType.Unsupported	The operating system type is not supported.
InvalidImageOsVersion.Unsupported	The operating system version is not supported.
InvalidParameter.InvalidParameterUrlError	Invalid URL.
InvalidParameterValue.ISOMustImportByForce	ISO files must be imported by force.
InvalidParameterValue.InvalidAppIdFormat	Invalid AppID
InvalidParameterValue.InvalidBootMode	Unsupported boot mode.
InvalidParameterValue.InvalidImageFamily	Invalid format of image family name
InvalidParameterValue.InvalidLicenseType	Invalid license type.
InvalidParameterValue.TagKeyNotFound	The specified tag does not exist
InvalidParameterValue.TooLarge	The parameter value exceeds the maximum limit.
OperationDenied.InnerUserProhibitAction	Operation denied: This is a restricted account.
RegionAbilityLimit.UnsupportedToImportImage	This region does not support importing images.

tencent cloud

Recent Pages

ImportImage

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Importing an image

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

ImportImage

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Importing an image

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？