DescribeInstancesMonitorHealth

DescribeInstancesMonitorHealth

1. API Description

This API is used to query server hardware health information.

Note

Batch operations are supported. The maximum number of instances in each request is 10.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceIds	Yes	Array of String	Instance ID(s). To obtain the instance ID, you can call DescribeInstances and look for instanceId in the response. The maximum number of instances in each request is 10.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
monitorHealthList	Array of InstanceHealth	List of hardware health information.

4. Code Example

Example

Query server hardware health information.

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. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​