Docs
api
UHost(UHost)
CreateCustomImage

Create Custom Image - CreateCustomImage

Overview

Create a custom image from the specified UHost instance.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateCustomImage.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
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
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
UHostIdstringUHost Instance ID See DescribeUHostInstanceYes
ImageNamestringImage NameYes
ImageDescriptionstringImage DescriptionNo
DataUDiskIds.Nstring[Array] The list of associated cloud disk data disk id. Note: The cloud disk data disk needs to enable the snapshot service.No

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
DataSnapshotIdsarray[string]UDisk Data Disk Snapshot ID ListNo

Example

Request Example

https://api.ucloud-global.com/?Action=CreateCustomImage
&Region=cn-bj2
&ProjectId=org-xxx
&UHostId=uhost-xxx
&ImageName=Test
&DataUDiskIds.N=TtzKXtvV

Response Example

{
  "Action": "CreateCustomImageResponse",
  "DataSnapshotIds": [
    "hoSgBxwr"
  ],
  "ImageId": "uimage-xxx",
  "RetCode": 0
}