Docs
api
UHost(UHost)
ImportCustomImage

Import Image - ImportCustomImage

Overview

Import the mirror file of UFile into UHost to generate a custom image

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ImportCustomImage.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
ImageNamestringImage NameYes
UFileUrlstringUFile Private Space AddressYes
OsTypestringOperating system platform, such as CentOS, Ubuntu, Windows, RedHat, etc., please refer to the image version of the control panel; if importing an operating system not on the control panel, the parameter is Other.Yes
OsNamestringFor detailed operating system version, please refer to the image version in the control panel; When OsType is Other, the input parameter is Other.Yes
FormatstringImage format, options include RAW, VHD, VMDK, qcow2Yes
AuthbooleanIs authorization required. Must fill in true.Yes
ImageDescriptionstringImage DescriptionNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
ImageIdstringImage IdNo

Example

Request Example

https://api.dezai.com/?Action=ImportCustomImage
&Region=cn-bj2
&ProjectId=asdf
&ImageName=mbfThSeV
&UFileUrl=https://***.cn-bj.ufileos.com/***
&OsType=CentOS
&OsName=CentOS 6.5 32位
&Format=VMDK
&Auth=1

Response Example

{
  "Action": "ImportCustomImageResponse",
  "ImageId": "uimage-xxxxx",
  "RetCode": 0
}