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 Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeImage`.	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
Zone	string	Availability Zone. See Availability Zone List	No
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
ImageType	string	Image type. Standard Image: Base, Image Market: Business, Custom Image: Custom, return all types by default.	No
OsType	string	Operating System Type: Linux, Windows. By default, all types are returned.	No
ImageId	string	Image Id	No
Offset	int	List start position offset, default is 0	No
Limit	int	Return data length, default is 20	No
PriceSet	int	Return price or not: 1 for return, 0 for not return; default is not return.	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
TotalCount	int	Total number of images that meet the conditions	No
ImageSet	array[UHostImageSet]	For a detailed list of images, see UHostImageSet	No

Data Model

UHostImageSet

Field Name	Type	Description Information	Required
Zone	string	Availability Zone, see Availability Zone List	No
ImageId	string	Image ID	No
ImageName	string	Image Name	No
OsType	string	Operating System Type: Linux, Windows	No
OsName	string	Operating System Name	No
ImageType	string	Image Type Standard Image: Base, Industry Image: Business, Custom Image: Custom	No
Features	array[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
FuncType	string	Industry Image Type (only industry images will return this value)	No
IntegratedSoftware	string	Integrated Software Name (only industry images will return this value)	No
Vendor	string	Supplier (only industry images will return this value)	No
Links	string	Introduction link (only industry images will return this value)	No
State	string	Image Status, Available: Available, Making: Making, Unavailable: Unavailable, Copying: Copying	No
ImageDescription	string	Image Description	No
CreateTime	int	Creation time, in Unix timestamp format	No
ImageSize	int	Image Size	No
MinimalCPU	string	The default value is empty. Images such as CentOS 7.3/7.4/7.5 will be marked as 'Broadwell'.	No
MaintainEol	string	System EOL (End of Life) date, format: YYYY/MM/DD	No
SupportedGPUTypes	array[string]	Supported GPU Models	No
SceneCategories	array[string]	Scene Classification, currently includes Featured, PreInstalledDrivers, AIPainting, AIModels, HPC (High Performance Computing)	No
PrimarySoftware	string	Main Installation Software	No

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
}

DescribeAvailableInstanceTypes DescribeIsolationGroup