Obtain information on all machine types available/sold out in a certain region - DescribeAvailableInstanceTypes

Overview

DescribeAvailableInstanceTypes

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeAvailableInstanceTypes`.	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 will be used. Sub-accounts must fill this in.	No
MachineTypes.N	string	Designated Machine Type List	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
AvailableInstanceTypes	array[AvailableInstanceTypes]	AvailableInstanceTypes	Yes
Status	string	Is the current region available for sale?	No

Data Model

AvailableInstanceTypes

Field Name	Type	Description Information	Required
Zone	string	Availability Zone Information	No
Name	string	Model Name: Speedy O Type\|O, Speedy Shared Type\|OM, Speedy Memory Type\|OMEM, Speedy PRO Type\|OPRO, General N Type\|N, High Frequency C Type\|C and GPU G Type\|G, etc.	No
Status	string	Machine Status: Available\|Normal, Public Test\|Beta, Sold Out\|Soldout, Hidden\|Hidden	No
CpuPlatforms	CpuPlatforms	Supported CPU platforms, and returns classified according to Intel, AMD, and Ampere.	No
Disks	array[Disks]	Disk Information. The main categories of disks are as follows: Cloud Disk\|cloudDisk, Normal Local Disk\|normalLocalDisk, and SSD Local Disk\|ssdLocalDisk. Among them, Cloud Disk mainly includes Normal Cloud Disk\|CLOUD_NORMAL, SSD Cloud Disk\|CLOUD_SSD, and RSSD Cloud Disk\|CLOUD_RSSD. Normal Local Disk only includes Normal Local Disk\|LOCAL_NORMAL. SSD Local Disk only includes SSD Local Disk\|LOCAL_SSD. MinimalSize is the minimum value of the disk. If this field is not present, the minimum value can be taken from the base image Size value (20G for Linux, 40G for Windows). MaximalSize is the maximum value of the disk. InstantResize indicates whether the system disk allows expansion. If it is a local disk, expansion is not allowed, and InstantResize is false. Features are the services supported by the disk: Data Ark\|DATAARK, Snapshot Service\|SNAPSHOT, Encrypted Disk\|Encrypted.	No
MachineSizes	array[MachineSizes]	GPU, CPU, and memory information. Gpu refers to the specifications that GPU can support, while Cpu and Memory refer to the specifications that CPU and memory can support respectively. If it is not a GPU model, GPU is 0. MinimalCpuPlatform represents that this CPU and memory specification can only be supported on the listed CPU platforms.	No
Features	array[Features]	Features supported by the virtual machine. The currently supported features are Network Enhancement\|NetCapability and Hot Upgrade\|Hotplug. Network Enhancement is divided into Off\|Normal, Network Enhancement 1.0\|Super, and Network Enhancement 2.0\|Ultra. Name is the name of the supported feature, Modes are the available mode categories, and RelatedToImageFeature is the tag on the image that supports this feature. For example, if the Features field returned by DescribeImage contains HotPlug, it means that the image supports hot upgrades. MinimalCpuPlatform indicates that this feature is only supported by the listed CPU platforms and above.	No
MachineClass	string	Distinguish whether it is a GPU model: GPU model\|GPU, non-GPU model\|Normal.	No
GraphicsMemory	GraphicsMemory	The metric of GPU's video memory, value is the value, the unit is GB.	No
Performance	Performance	The performance indicator of the GPU, where 'value' is the value, and the unit is TFlops.	No

CpuPlatforms

Field Name	Type	Description Information	Required
Intel	array[string]	Return the CPU platform information of Intel, for example: Intel: ['Intel/CascadeLake','Intel/CascadelakeR','Intel/IceLake']	No
Amd	array[string]	Return the CPU platform information of AMD, for example: AMD: ['Amd/Epyc2']	No
Ampere	array[string]	Return the CPU platform information of Arm, for example: Ampere: ['Ampere/Altra']	No

Disks

Field Name	Type	Description Information	Required
Name	string	Disk medium category information, the main categories of disks are as follows: Cloud Disk\|cloudDisk, Normal Local Disk\|normalLocalDisk and SSD Local Disk\|ssdLocalDisk.	No
BootDisk	array[BootDiskInfo]	System Disk Information	No
DataDisk	array[DataDiskInfo]	Data Disk Information	No

MachineSizes

Field Name	Type	Description Information	Required
Gpu	int	Gpu refers to the specifications that GPU can support, namely the number of GPU cores. For non-GPU models, Gpu is 0.	No
Collection	array[Collection]	Specifications supported by CPU and memory	No

Features

Field Name	Type	Description Information	Required
Name	string	Supported feature names. Currently supported features are Network Enhancement\|NetCapability, Hot Upgrade\|Hotplug.	No
Modes	array[FeatureModes]	Available mode categories	No

GraphicsMemory

Field Name	Type	Description Information	Required
Value	int	Value, unit is GB	No
Rate	int	Interactive display parameters, can be ignored	No

Performance

Field Name	Type	Description Information	Required
Value	float	Value, the unit is TFlops	No
Rate	int	Interactive display parameters, can be ignored	No

FeatureModes

Field Name	Type	Description Information	Required
Name	string	Pattern\|Feature Name	No
RelatedToImageFeature	array[string]	For the tag that supports this feature on the image. For example, the field 'Features' returned by 'DescribeImage' contains 'HotPlug', which indicates that the image supports hot upgrades.	No
MinimalCpuPlatform	array[string]	This feature is only supported by the CPU platforms and above that are listed.	No

Collection

Field Name	Type	Description Information	Required
Cpu	int	CPU Specifications	No
Memory	array[int]	Memory Specification	No
MinimalCpuPlatform	array[string]	CPU and memory specifications can only be supported on the listed CPU platforms.	No

BootDiskInfo

Field Name	Type	Description Information	Required
Name	string	System disk category, including ordinary cloud disk\|CLOUD_NORMAL, SSD cloud disk\|CLOUD_SSD and RSSD cloud disk\|CLOUD_RSSD. The ordinary local disk only includes ordinary local disk\|LOCAL_NORMAL. The SSD local disk only includes SSD local disk\|LOCAL_SSD.	No
InstantResize	boolean	Whether the system disk allows expansion. If it is a local disk, expansion is not allowed, InstantResize is set to false.	No
MaximalSize	int	MaximalSize is the maximum value of the disk	No
Features	array[string]	Services Supported by Disk	No

DataDiskInfo

Field Name	Type	Description Information	Required
MinimalSize	int	Minimum disk size. If this field is not present, the minimum value defaults to the base image size (20G for Linux, 40G for Windows).	No
Name	string	Data disk types, including ordinary cloud disk\|CLOUD_NORMAL, SSD cloud disk\|CLOUD_SSD and RSSD cloud disk\|CLOUD_RSSD. The ordinary local disk only includes ordinary local disk\|LOCAL_NORMAL. The SSD local disk only includes SSD local disk\|LOCAL_SSD.	No
MaximalSize	int	MaximalSize is the maximum value of the disk	No
Features	array[string]	Services Supported by Data Disk	No

Example

Request Example

https://api.ucloud-global.com/?Action=DescribeAvailableInstanceTypes
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=qOkTGfWf
&MachineTypes.N=STscCopU

Response Example

{
  "Action": "DescribeAvailableInstanceTypesResponse",
  "AvailableInstanceTypes": "sNSlnDFQ",
  "RetCode": 0,
  "Status": "UGBTxoLj"
}

DeleteUHostKeyPairs DescribeImage