1)接口功能介绍
获取实例监控指标信息。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取,返回的数据粒度是一分钟。
3)URI
GET /v1/describeMonitorData。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
id | 是 | String | 虚拟机id | evm-xxxxxx | |
startTime | 否 | String | 开始时间(Unix时间戳,秒),startTime和endTime均为空时,默认返回最近5分钟的数据 | 1342342343 | |
endTime | 否 | String | 结束时间(Unix时间戳,秒),startTime和endTime均为空时,默认返回最近5分钟的数据 | 1342342343 | |
indicators | 否 | String | 监控指标集合,值为以下值的一个,cpu_usage - CPU使用率,memory_usage - 内存使用率,device_reads_iops - 磁盘读iops,device_writes - 磁盘写速率,mem_usage - 内存使用量,device_write_times_ms - 磁盘写延迟(ms),nw_transmit - 网络发送速率,device_writes_iops - 磁盘写iops,device_read_times_ms - 磁盘读延迟(ms),device_reads - 磁盘读速率,nw_receive - 网络接收速率,不填默认所有监控均返回 | cpu_usage |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | 指标名称 | cpu_usage | |
series | 否 | Object | 点集合 | Series |
表 series
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | 指标中文名 | cpu使用率 | |
dataPoints | 否 | List | 线 | dataPoints |
表 dataPoints
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
timestamp | 否 | Integer | 数据点时间戳,unixtime(s) | 1669949819 | |
Value | 否 | Float | 数据点值 | 434.89 |
6)请求示例
GET https://{host}/v1/describeMonitorData?indicators=cpu_usage&nodeCode=hn-changde-1&id=evm-cdushff19r7fam2ea12g&startTime=1669910400&endTime=1669910700
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"cpu_usage": {
"series": [
{
"data_points": [
{
"timestamp": "1669910400",
"value": 0.17543859649122806
},
{
"timestamp": "1669910460",
"value": 0.17543859649122806
},
{
"timestamp": "1669910520",
"value": 0.17543859649122806
},
{
"timestamp": "1669910580",
"value": 0.17543828870475664
},
{
"timestamp": "1669910640",
"value": 0.17543828870475664
},
{
"timestamp": "1669910700",
"value": 0.17543890427877948
}
],
"name": "evm-cdushff19r7fam2ea12g"
}
],
"name": "CPU使用率"
}
},
"requestId": "434778b5-c910-45ee-aa60-584989b4c7f5"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |