Skip to Content
裸金属云主机 UPHost获取物理机信息 - DescribePHost

获取物理机信息 - DescribePHost

简介

获取物理机详细信息

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribePHostYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表No
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
PHostId.NstringPHost资源ID，若为空，则返回当前Region所有PHost。No
Offsetint数据偏移量，默认为0No
Limitint返回数据长度，默认为20No
UDiskIdForAttachmentstring要挂载的云盘id，过滤返回能被UDiskId挂载的云主机。目前主要针对rssd云盘使用No
VPCIdstringULB使用参数，获取同VPC下机器信息。No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
TotalCountint满足条件的PHost总数No
PHostSetarray[PHostSet]PHost资源列表，参见 PHostSetNo

数据模型

PHostSet

字段名类型描述信息必填
Zonestring可用区，参见 可用区列表No
PHostIdstringPHost资源IDNo
SNstring物理机序列号No
PMStatusstring物理云主机状态。枚举值：

> 初始化:Initializing;

> 启动中：Starting；

> 运行中：Running；

> 关机中：Stopping；

> 安装失败：InstallFailed；

> 重启中：Rebooting；

> 关机：Stopped；

> 迁移中(裸金属云盘)：Migrating		No
Namestring物理机名称No
Remarkstring物理机备注No
Tagstring业务组No
ImageNamestring镜像名称No
OSnamestring操作系统名称No
CreateTimeint创建时间No
ExpireTimeint到期时间No
ChargeTypestring计费模式，枚举值为： Year，按年付费； Month，按月付费；默认为月付No
PowerStatestring电源状态，on 或 offNo
PHostTypestring物理机类型，参见DescribePHostMachineType返回值No
Memoryint内存大小，单位：MBNo
CPUSetPHostCPUSetCPU信息，见 PHostCPUSetNo
DiskSetarray[PHostDescDiskSet]磁盘信息，见 PHostDescDiskSetNo
IPSetarray[PHostIPSet]IP信息，见 PHostIPSetNo
Clusterstring网络环境。枚举值：千兆：1G ，万兆：10GNo
AutoRenewstring自动续费No
IsSupportKVMstring是否支持紧急登录No
OSTypestring操作系统类型No
Componentsstring组件信息（暂不支持）No
RaidSupportedstring是否支持Raid。枚举值：Yes：支持；No：不支持。No
PhostClassstring物理云产品类型，枚举值：LocalDisk=>代表传统本地盘机型， CloudDisk=>云盘裸金属机型No
BootDiskStatestring裸金属机型字段。枚举值：Normal=>正常、ImageMaking=>镜像制作中。No
RdmaClusterIdstringRDMA集群id，仅云盘裸金属返回该值；其他类型物理云主机返回""。当物理机的此值与RSSD云盘的RdmaClusterId相同时，RSSD可以挂载到这台物理机。No

PHostCPUSet

字段名类型描述信息必填
ModelstringCPU型号No
FrequencefloatCPU主频No
CountintCPU个数No
CoreCountintCPU核数No

PHostDescDiskSet

字段名类型描述信息必填
Spaceint单盘大小，单位GBNo
Countint磁盘数量No
Typestring磁盘属性No
Namestring磁盘名称，sys/dataNo
IOCapint磁盘IO性能，单位MB/s（待废弃）No
Drivestring裸金属机型参数：磁盘盘符No
DiskIdstring裸金属机型参数：磁盘IDNo
IsBootstring裸金属机型参数：是否是启动盘。True/FalseNo

PHostIPSet

字段名类型描述信息必填
OperatorNamestring国际: Internation， BGP: BGP， 内网: PrivateNo
IPIdstringIP资源ID(内网IP无资源ID)（待废弃）No
IPAddrstringIP地址，No
MACAddrstringMAC地址No
BandwidthintIP对应带宽，单位Mb，内网IP不显示带宽信息No
SubnetIdstring子网IDNo
VPCIdstringVPC IDNo

示例

请求示例

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

响应示例

{
  "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