ImportImage

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ImportImage) is used to import images. The imported images can be used to create instances.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-10-28 03:52:47.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ImportImage
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
Architecture Yes No String Operating system architecture of imported images, x86_64 or arm_64.
Example: x86_64
OsType Yes No String Operating system type of imported images, obtained through DescribeImportImageOs.
Example: CentOS
OsVersion Yes No String Operating system version of imported image, obtained through DescribeImportImageOs.
Example: 6
ImageUrl Yes No String COS Address Where Imported Image is Stored
Example: http://111-1251433127.cosd.convergecloud.com/Windows%20Server%202008%20R2%20x64a.vmdk
ImageName Yes No String Image name. The image name should not be the same as the name of any existing custom images, and no more than 60 characters.
Example: sample
ImageDescription No No String Description
Example: sampleimage
DryRun No No Bool Check parameters only, do not execute task.
Example: false
Force No No Bool Whether to forcibly import, see Forcibly Import Image
Example: false
PublicImage No No Bool Whether to import a public image. Set to true to import a public image and follow the imagestage process. Default value is false;
Example: true

3. Output Parameters

Parameter name Type Description
ImageId String Image ID
Example: img-c1otssej
TaskId String Task ID
Example: 432322
flowId Int64 Task Flow ID
Example: 3
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
FailedOperation.NoAvailablePublicImage No available public images.
FailedOperation.NoQuotaForUserInstance Insufficient quota to create an instance.
FailedOperation.NoAvailableInstanceFamily No available instance families.
FailedOperation.NoAvailableInstanceType No available instance types.
FailedOperation.NoAvailableIpAddressCount The subnet has no available IP addresses.
FailedOperation.NoAvailableCbs No available CBS resources.
FailedOperation.NoCVMPermission No instance operation permissions.
FailedOperation.NoAvailableVpc There are no available VPC resources.
FailedOperation.NoAvailableSubnet There are no available subnet resources.
FailedOperation.NoAvailableSecurityGroup No available security groups.
ImageQuotaLimitExceeded The image quota has exceeded the limit.
InvalidImageName.Duplicate The image name is the same as the existing image.
InvalidImageOsVersion.Unsupported Unsupported operating system version.
InvalidParameter.InvalidParameterUrlError Incorrect URL address.
RegionAbilityLimit.UnsupportedToImportImage This region does not support importing images.
InvalidImageOsType.Unsupported Unsupported operating system type.
MissingParameter Parameters are missing. The request did not include mandatory parameters.