Skip to Content
裸金属云主机 UPHost获取物理机镜像 - DescribePHostImage

获取物理机镜像 - DescribePHostImage

简介

获取物理云主机镜像列表

定义

公共参数

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

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
ImageTypestring镜像类别，枚举值，Base是基础镜像；Custom是自制镜像。No
ImageId.Nstring镜像IDNo
Offsetint数据偏移量，默认为0No
Limitint返回数据长度，默认为20No
MachineTypestring机器型号，只支持当前zone的展示机型No
Clusterstring机器的网络集群，MachineType传是必须传，默认25GNo

响应字段

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

数据模型

PHostImageSet

字段名类型描述信息必填
ImageIdstring镜像IDNo
ImageNamestring镜像名称No
OsNamestring操作系统名称No
OsTypestring操作系统类型No
Supportarray[string]支持的机型No
Versionstring当前版本No
ImageTypestring枚举值：Base=>基础镜像，Custom=>自制镜像。No
CreateTimestring裸金属2.0参数。镜像创建时间。No
Statestring裸金属2.0参数。镜像当前状态。No
ImageSizeint裸金属2.0参数。镜像大小。No
ImageDescriptionstring镜像描述No

示例

请求示例

https://api.tnqacloud.com/?Action=DescribePHostImage
&Region=lPknnhFJ
&Zone=BkUzrVGH
&ProjectId=tLfmjwpi
&ImageType=Ajlqqiqf
&ImageId.n=hmIDkOMO
&Offset=7
&Limit=1
&MachineType=QxVNPRCH
&Cluster=DkUhdXDD

响应示例

{
  "Action": "DescribePHostImageResponse",
  "ImageSet": [
    {
      "ImageId": "jMonPUZs",
      "ImageName": "zZHLkcpk",
      "OsName": "ICNxbWaj",
      "OsType": "KinGDoGa",
      "Support": [
        "rVxQDlcE"
      ],
      "Version": "EtexDjJR"
    }
  ],
  "RetCode": 0,
  "TotalCount": 5
}
获取物理机信息 - DescribePHost获取物理云机型信息 - DescribePHostMachineType