Domain name for API request: cvm.tencentcloudapi.com.
This API is used to import images. Imported images can be used to create 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: ImportImage. |
| 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. |
| 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. |
| Parameter Name | Type | Description |
|---|---|---|
| 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 import an image.
GET https://cvm.tencentcloudapi.com/?Action=ImportImage
&OsType=CentOS
&OsVersion=6
&ImageName=sample
&ImageDescription=sampleimage
&ImageUrl=http://111-1251233127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk
&Architecture=x86_64
&<Common request parameters>{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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. |
| 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.TooLarge | The parameter value exceeds the maximum limit. |
| RegionAbilityLimit.UnsupportedToImportImage | This region does not support importing images. |
Was this page helpful?