Import Image - ImportCustomImage
Overview
Import the mirror file of UFile into UHost to generate a custom image
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is ImportCustomImage. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
| ImageName | string | Image Name | Yes |
| UFileUrl | string | UFile Private Space Address | Yes |
| OsType | string | Operating 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 |
| OsName | string | For detailed operating system version, please refer to the image version in the control panel; When OsType is Other, the input parameter is Other. | Yes |
| Format | string | Image format, options include RAW, VHD, VMDK, qcow2 | Yes |
| Auth | boolean | Is authorization required. Must fill in true. | Yes |
| ImageDescription | string | Image Description | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| ImageId | string | Image Id | No |
Example
Request Example
https://api.surfercloud.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=1Response Example
{
"Action": "ImportCustomImageResponse",
"ImageId": "uimage-xxxxx",
"RetCode": 0
}