DescribeInstancesMonitorHealth

1. 接口描述

调用本接口用于查询实例的硬件状态信息。

注意事项

支持批量操作。每次请求批量实例的上限为10。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

instanceIds

是

Array of String

一个或多个待操作的实例ID。

可通过DescribeInstances接口返回值中的instanceId获取。每次请求批量实例的上限为10。

3. 响应结果

名称

类型

描述

requestId

String

唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

monitorHealthList

Array of InstanceHealth

硬件状态信息列表。

4. 代码示例

查询实例的硬件状态信息。

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeInstancesMonitorHealth
<Common Request Params>

Request:
{
  "instanceIds": [
    "instanceId1",
    "instanceId2"
  ]
}

Response:
{
  "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
  "response": {
    "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
    "monitorHealthList": [
      {
        "instanceId": "instanceId1",
        "cpuStatus": "UNKNOWN",
        "diskStatus": "UNKNOWN",
        "ipmiPing": "OK",
        "ipmiStatus": "OK",
        "memoryStatus": "UNKNOWN",
        "psuStatus": "OK",
        "wanPortStatus": "OK",
        "fanStatus": "OK",
        "serverBrand": "SUPERMICRO",
        "serverModel": "SYS-5039MS-H8TRF",
        "cpuTemp": 40,
        "inletTemp": 20,
        "tempUnit": "Celsius"
      },
      {
        "instanceId": "instanceId2",
        "cpuStatus": "UNKNOWN",
        "diskStatus": "UNKNOWN",
        "ipmiPing": "OK",
        "ipmiStatus": "OK",
        "memoryStatus": "UNKNOWN",
        "psuStatus": "OK",
        "wanPortStatus": "OK",
        "fanStatus": "OK",
        "serverBrand": "SUPERMICRO",
        "serverModel": "SYS-5039MS-H8TRF"
        "cpu0Temp": 40,
        "cpu1Temp": 39
        "inletTemp": 20,
        "tempUnit": "Celsius"
      }
    ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

最后更新于8个月前