docs
api
UHost(UHost)
DescribeImage

Get Image List - DescribeImage

Overview

Retrieve the image list of the specified data center. Users can filter by specifying the operating system type and image Id.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeImage.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
ImageTypestringImage type. Standard Image: Base, Image Market: Business, Custom Image: Custom, return all types by default.No
FuncTypestringImage attribution, enumeration values: ["gpu","app","uhost"]. "gpu": Industry images processed for gpu; "app": Images dedicated for light cloud hosts; "uhost": Industry images for the cloud host image market. FuncType parameter errors will be ignored.No
OsTypestringOperating System Type: Linux, Windows. By default, all types are returned.No
ImageIdstringImage IdNo
OffsetintList start position offset, default is 0No
LimitintReturn data length, default is 20No
PriceSetintReturn price or not: 1 for return, 0 for not return; default is not return.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
TotalCountintTotal number of images that meet the conditionsNo
ImageSetarray[UHostImageSet]For a detailed list of images, see UHostImageSetNo

Data Model

UHostImageSet

Field NameTypeDescription InformationRequired
ZonestringAvailability Zone, see Availability Zone ListNo
ImageIdstringImage IDNo
ImageNamestringImage NameNo
OsTypestringOperating System Type: Linux, WindowsNo
OsNamestringOperating System NameNo
ImageTypestringImage Type Standard Image: Base, Industry Image: Business, Custom Image: CustomNo
Featuresarray[string]Special status identifiers, currently includes NetEnhnced (Network Enhancement 1.0), NetEnhanced_Ultra (Network Enhancement 2.0), NetEnhanced_Extreme (Network Enhancement 3.0), HotPlug (Hot Upgrade), GPU (GPU Image), CloudInit, IPv6 (Supports IPv6 Network), RssdAttachable (Supports RSSD Cloud Disk), Vgpu_AMD (Supports AMD's vgpu), Vgpu_NVIDIA (Supports NVIDIA's vgpu), Aarch64_Type (Supports arm64 architecture)No
FuncTypestringImage attribution, enumeration values: ["gpu","app","uhost"]. "gpu": Industry images processed for gpu; "app": Images dedicated for light cloud hosts; "uhost": Industry images for the cloud host image market.No
IntegratedSoftwarestringIntegrated Software Name (only industry images will return this value)No
VendorstringSupplier (only industry images will return this value)No
LinksstringIntroduction link (only industry images will return this value)No
StatestringImage Status, Available: Available, Making: Making, Unavailable: Unavailable, Copying: CopyingNo
ImageDescriptionstringImage DescriptionNo
CreateTimeintCreation time, in Unix timestamp formatNo
ImageSizeintImage SizeNo
MinimalCPUstringThe default value is empty. Images such as CentOS 7.3/7.4/7.5 will be marked as 'Broadwell'.No
MaintainEolstringSystem EOL (End of Life) date, format: YYYY/MM/DDNo
SupportedGPUTypesarray[string]Supported GPU ModelsNo
SceneCategoriesarray[string]Scene Classification, currently includes Featured, PreInstalledDrivers, AIPainting, AIModels, HPC (High Performance Computing)No
PrimarySoftwarestringMain Installation SoftwareNo

Example

Request Example

https://api.surfercloud.com/?Action=DescribeImage
&Region=PhaAzVTd
&Zone=cqKjGzBc
&ProjectId=COzFsxJJ
&ImageType=gzhDcTIW
&OsType=YKGOVXER
&ImageId=NucmrhHv
&Offset=7
&Limit=3
&PriceSet=8
&FuncType=VQKlDpNp
&FuncType=SKKAirKJ
&FuncType=VSVNRRqM

Response Example

{
  "Action": "DescribeImageResponse",
  "ImageSet": [
    {
      "CreateTime": 7,
      "Features": [
        "fIjpPBic"
      ],
      "FuncType": "HUUNWmIe",
      "ImageDescription": "HVeLQVxc",
      "ImageId": "DSFagZyu",
      "ImageName": "tLrQRsEd",
      "ImageSize": 5,
      "ImageType": "qHUuzcMF",
      "IntegratedSoftware": "IHavDZNf",
      "Links": "fKLwvSib",
      "MinimalCPU": "RDlcZqYK",
      "OsName": "NxoYUnar",
      "OsType": "DxLQCAes",
      "State": "eGSoZznP",
      "Vendor": "JjBqzeus",
      "Zone": "BOUCCxQH"
    }
  ],
  "RetCode": 0,
  "TotalCount": 4
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.