# 获取物理机镜像 - DescribePHostImage

## 简介

获取物理云主机镜像列表





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribePHostImage`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.genesissai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **ImageType** | string | 镜像类别，枚举值，Base是基础镜像；Custom是自制镜像。 |No|
| **ImageId.N** | string | 镜像ID |No|
| **Offset** | int | 数据偏移量，默认为0 |No|
| **Limit** | int | 返回数据长度，默认为20 |No|
| **MachineType** | string | 机器型号，只支持当前zone的展示机型 |No|
| **Cluster** | string | 机器的网络集群，MachineType传是必须传，默认25G |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **TotalCount** | int | 满足条件的镜像总数 |No|
| **ImageSet** | array[[*PHostImageSet*](#PHostImageSet)] | 镜像列表 PHostImageSet |No|

#### 数据模型


#### PHostImageSet

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ImageId** | string | 镜像ID |No|
| **ImageName** | string | 镜像名称 |No|
| **OsName** | string | 操作系统名称 |No|
| **OsType** | string | 操作系统类型 |No|
| **Support** | array[string] | 支持的机型 |No|
| **Version** | string | 当前版本 |No|
| **ImageType** | string | 枚举值：Base=>基础镜像，Custom=>自制镜像。 |No|
| **CreateTime** | string | 裸金属2.0参数。镜像创建时间。 |No|
| **State** | string | 裸金属2.0参数。镜像当前状态。 |No|
| **ImageSize** | int | 裸金属2.0参数。镜像大小。 |No|
| **ImageDescription** | string | 镜像描述 |No|

## 示例

### 请求示例
    
```
https://api.genesissai.com/?Action=DescribePHostImage
&Region=lPknnhFJ
&Zone=BkUzrVGH
&ProjectId=tLfmjwpi
&ImageType=Ajlqqiqf
&ImageId.n=hmIDkOMO
&Offset=7
&Limit=1
&MachineType=QxVNPRCH
&Cluster=DkUhdXDD
```

### 响应示例
    
```json
{
  "Action": "DescribePHostImageResponse",
  "ImageSet": [
    {
      "ImageId": "jMonPUZs",
      "ImageName": "zZHLkcpk",
      "OsName": "ICNxbWaj",
      "OsType": "KinGDoGa",
      "Support": [
        "rVxQDlcE"
      ],
      "Version": "EtexDjJR"
    }
  ],
  "RetCode": 0,
  "TotalCount": 5
}
```