docs
api
Physical Cloud Host(UPHost)
DescribeBaremetalMachineType

Get detailed information about BareMetal machine types - DescribeBaremetalMachineType

Overview

Get detailed description information of BareMetal machine type

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeBaremetalMachineType.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 ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
TypestringSpecific machine type. If not filled in, all machine types will be returned.No
APIVersionstringRequest version. Only v2 is supported, not passing or passing other values means requesting the old version.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
MachineTypesarray[PHostCloudMachineTypeSetV2]Machine type list, Model: PHostCloudMachineTypeSetV2, only returned when the input parameter Version=v2No

Data Model

PHostCloudMachineTypeSetV2

Field NameTypeDescription InformationRequired
ZonestringAvailability Zone of the Machine TypeYes
CPUPHostCPUSetV2CPU InformationYes
Disksarray[PHostDiskSetV2]Disk InformationYes
Componentsarray[PHostComponentSet]Component InformationYes
TypestringPhysical Cloud Host Type AliasYes
RaidSupportedstringDoes it support Raid. Enumeration values: Yes; No.Yes
MemoryintMemory size, unit MBYes
IsBaremetalbooleanIs it a BareMetal model?No
IsNewbooleanDo you need to add a new machine type tag?No
GpuInfoPHostGpuInfoV2GPU InformationNo
OnSalebooleanUsually what is obtained is sellable.No
StockintInventory QuantityNo
StockStatusstringInventory status. Enumerated values: Available; Sold OutNo
PriceobjectReference Price. Dictionary type, default: for default price; cn-wlcb-01: price for Ulanqab A availability zone.No
ClusterstringCluster name. Enumeration values: Gigabit Network Cluster: 1G; 10 Gigabit Network Cluster: 10G; Smart NIC Network: 25G;No
Scenearray[string]Applicable scenarios. For example: ai represents AI learning scenarios;No
IsGpubooleanIs it a GPU model?No

PHostCPUSetV2

Field NameTypeDescription InformationRequired
CoreCountintCPU CoresYes
CountintNumber of CPUsYes
ModelstringCPU ModelYes
FrequencystringCPU Clock SpeedNo

PHostDiskSetV2

Field NameTypeDescription InformationRequired
SpaceintSpace SizeYes
NamestringDisk NameYes
IoCapintI/O PerformanceNo
NumberintQuantityNo
UnitSizeintConversion UnitNo
RaidLevelintRaid LevelNo
DiskTypeintDisk TypeNo

PHostComponentSet

Field NameTypeDescription InformationRequired
NamestringComponent NameNo
CountintNumber of ComponentsNo

PHostGpuInfoV2

Field NameTypeDescription InformationRequired
NamestringGPU Name, for example: NVIDIA_V100SYes
CountintNumber of GPUsYes
MemorystringGPU Memory SizeYes
PerformancestringGPU Performance MetricsYes

Example

Request Example

https://api.surfercloud.com/?Action=DescribeBaremetalMachineType
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=DjVQZCeC
&Type=YOdfvZKs
&Version=degvdYhk

Response Example

{
  "Action": "DescribeBaremetalMachineTypeResponse",
  "MachineTypes": [
    {}
  ],
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved