DescribeInstanceMonitorData

1. 接口描述

调用本接口用于查询实例在指定时间段内的监控指标数据。

注意事项

• 开始时间和结束时间的跨度不能超过一天。

2. 请求参数

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

参数名称	必选	类型	描述
instanceId	是	String	实例ID。
metricType	是	String	指标类型。 INTERNET_INGRESS_BITS: 公网入向带宽，单位bps INTERNET_EGRESS_BITS: 公网出向带宽，单位bps INTERNET_INGRESS_PACKETS: 公网入向包量 INTERNET_EGRESS_PACKETS: 公网出向包量 CPU_UTIL: CPU使用率，单位百分比 MEMORY_UTIL: 内存使用率，单位百分比 DISK_WRITE_BYTES: 云盘的每秒写入字节，单位Byte DISK_READ_BYTES: 云盘的每秒读取字节，单位Byte DISK_READ_OPS: 云盘的每秒读取IOPS DISK_WRITE_OPS: 云盘的每秒写入IOPS
ipAddress	否	String	公网IP地址。 当存在多个IP时，需要指定对应网卡上的公网地址。该字段仅对下列指标有效。 INTERNET_INGRESS_BITS INTERNET_EGRESS_BITS INTERNET_INGRESS_PACKETS INTERNET_EGRESS_PACKETS
startTime	是	String	查询开始时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
endTime	是	String	查询结束时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。

3. 响应结果

名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。
maxValue	Float	指标数据的最大值，单位取决于指标类型。
avgValue	Float	指标数据的平均值，单位取决于指标类型。
dataList	Array of MetricValue	指标数据列表。

4. 代码示例

示例

1. 查询实例一段时间内的公网出向带宽数据。

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

Request:
{
  "instanceId": "ist2a/xxxxxx-xxxx-xxxx-xxxx-xxxxxx",
  "ipAddress": "128.0.0.1",
  "metricType": "INTERNET_EGRESS_BITS",
  "startTime": "2024-04-11T08:00:00Z",
  "endTime": "2024-04-11T08:10:00Z"
}

Response:
{
  "requestId": "TE1375F34-6DC9-4BED-BDF2-DC9D07E4D3A6",
  "response": {
    "requestId": "TE1375F34-6DC9-4BED-BDF2-DC9D07E4D3A6",
    "maxValue": 6,
    "avgValue": 5,
    "dataList": [
        {
            "timeInSecond": 1708488055,
            "value": 5
        },
        {
            "timeInSecond": 1708488100,
            "value": 6
        },
        {
            "timeInSecond": 1708488160,
            "value": 5
        },
        {
            "timeInSecond": 1708488220,
            "value": 6
        }
    ]
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
404	INVALID_INSTANCE_NOT_FOUND	指定的实例不存在。
403	INVALID_START_TIME_MUST_BEFORE_END_TIME	开始时间必须在结束时间之前。
403	INVALID_TIME_RANGE	无效的时间范围。查询跨度必须在一天之内。
403	TIME_OUT_OF_RANGE	查询的时间必须在30天之内。