Obtain physical machine information - DescribePHost

Overview

Get detailed information of the physical machine

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribePHost`.	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
PHostId.N	string	PHost Resource ID, if it is empty, then return all PHosts in the current Region.	No
Offset	int	Data offset, default is 0	No
Limit	int	Return data length, default is 20	No
UDiskIdForAttachment	string	The ID of the cloud disk to be mounted, filter and return the cloud host that can be mounted by UDiskId. Currently mainly used for rssd cloud disk.	No
VPCId	string	ULB usage parameters, obtain machine information under the same VPC.	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 Qualified PHost	No
PHostSet	array[PHostSet]	PHost Resource List, see PHostSet	No

Data Model

PHostSet

Field Name	Type	Description Information	Required
Zone	string	Availability Zone, see Availability Zone List	No
PHostId	string	PHost Resource ID	No
SN	string	Physical Machine Serial Number	No
PMStatus	string	Physical cloud host status. Enumerated values: > Initializing: Initializing; > Starting: Starting; > Running: Running; > Stopping: Stopping; > InstallFailed: Install Failed; > Rebooting: Rebooting; > Stopped: Stopped; > Migrating (BareMetal cloud disk): Migrating	No
Name	string	Physical Machine Name	No
Remark	string	Physical Machine Remarks	No
Tag	string	Business Group	No
ImageName	string	Image Name	No
OSname	string	Operating System Name	No
CreateTime	int	Creation Time	No
ExpireTime	int	Expiration Date	No
ChargeType	string	Billing mode, enumeration values are: Year, paid annually; Month, paid monthly; Default is monthly.	No
PowerState	string	Power status, on or off	No
PHostType	string	Physical machine type, see the return value of DescribePHostMachineType	No
Memory	int	Memory size, unit: MB	No
CPUSet	PHostCPUSet	CPU Information, see PHostCPUSet	No
DiskSet	array[PHostDescDiskSet]	Disk Information, see PHostDescDiskSet	No
IPSet	array[PHostIPSet]	IP Information, see PHostIPSet	No
Cluster	string	Network environment. Enumerated values: Gigabit: 1G, Ten Gigabit: 10G	No
AutoRenew	string	Auto Renewal	No
IsSupportKVM	string	Does it support emergency login?	No
OSType	string	Operating System Type	No
Components	string	Component Information (Not Supported Yet)	No
RaidSupported	string	Does it support Raid. Enumerated values: Yes: Supported; No: Not supported.	No
PhostClass	string	Physical cloud product type, enumeration values: LocalDisk=> represents traditional local disk model, CloudDisk=> cloud disk bare metal model	No
BootDiskState	string	BareMetal machine type field. Enumerated values: Normal => Normal, ImageMaking => Image Making in Progress.	No
RdmaClusterId	string	RDMA cluster id, only returned by BareMetal cloud disk; other types of physical cloud hosts return "". When the value of this physical machine is the same as the RdmaClusterId of the RSSD cloud disk, the RSSD can be mounted to this physical machine.	No

PHostCPUSet

Field Name	Type	Description Information	Required
Model	string	CPU Model	No
Frequence	float	CPU Clock Speed	No
Count	int	Number of CPUs	No
CoreCount	int	CPU Cores	No

PHostDescDiskSet

Field Name	Type	Description Information	Required
Space	int	Single disk size, unit GB	No
Count	int	Number of Disks	No
Type	string	Disk Attributes	No
Name	string	Disk Name, sys/data	No
IOCap	int	Disk IO performance, unit MB/s (to be deprecated)	No
Drive	string	BareMetal Machine Parameters: Disk Drive Letter	No
DiskId	string	BareMetal Machine Parameters: Disk ID	No
IsBoot	string	BareMetal Machine Parameters: Is it a boot disk. True/False	No

PHostIPSet

Field Name	Type	Description Information	Required
OperatorName	string	International: International, BGP: BGP, Private Network: Private	No
IPId	string	IP Resource ID (No resource ID for internal IP) (To be deprecated)	No
IPAddr	string	IP Address	No
MACAddr	string	MAC Address	No
Bandwidth	int	Bandwidth corresponding to IP, unit Mb, bandwidth information is not displayed for internal IP	No
SubnetId	string	Subnet ID	No
VPCId	string	VPC ID	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribePHost
&Region=jpfMKyfI
&Zone=vdTrBzdz
&ProjectId=edaZIUNR
&PHostId.n=wdKzhBfK
&Offset=2
&Limit=9
&UDiskIdForAttachment=XmuOwhco
&VPCId=xnyTdDlO

Response Example

{
  "Action": "DescribePHostResponse",
  "PHostSet": [
    {
      "AutoRenew": "vElhSowt",
      "CPUSet": {},
      "ChargeType": "HOJWsIek",
      "Cluster": "SvWpSdGG",
      "Components": "NHahHEJf",
      "CreateTime": 9,
      "DiskSet": [
        {
          "Count": 2,
          "DiskId": "PVQamRGq",
          "Drive": "iIFxawYp",
          "IOCap": 2,
          "IsBoot": "IAZXBkLX",
          "Name": "YQkYorHg",
          "Space": 5,
          "Type": "hLDhTxqn"
        }
      ],
      "ExpireTime": 5,
      "IPSet": [
        {
          "Bandwidth": 3,
          "IPAddr": "qCusNtNv",
          "IPId": "LwjcdFGT",
          "MACAddr": "PSlpiPlG",
          "OperatorName": "gUOcEZye",
          "SubnetId": "ixWBJCUq",
          "VPCId": "zwqAPBrO"
        }
      ],
      "ImageName": "gUYdJqug",
      "IsSupportKVM": "KqCCSXRY",
      "Memory": 7,
      "Name": "FozvyzAs",
      "OSType": "sEcEUJdn",
      "OSname": "oUGwtCWs",
      "PHostId": "tGnqGyiM",
      "PHostType": "JhbxVSaA",
      "PMStatus": "HJDlIYWi",
      "PhostClass": "hPSEhtat",
      "PowerState": "cBAaaIxY",
      "RaidSupported": "GgiMyJLC",
      "Remark": "etGTUBlU",
      "SN": "zPIhEFwm",
      "Tag": "HLukoXZc",
      "Zone": "zubgQpUw"
    }
  ],
  "RetCode": 0,
  "TotalCount": 5
}

DescribeBaremetalMachineType DescribePHostImage