监控看板

监控看板：视图数据查询

接口功能介绍

查询看板下某个视图的数据。

接口约束

参见请求参数说明。

URI

POST /v4/monitor/monitor-board/query-view-data

路径参数

无

Query参数

无

请求参数

请求头header参数

无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
viewID	是	String	面板ID	fb33ae47-415f-4026-23ad-c8492a667e9c
startTime	否	Integer	查询起始Unix时间戳, startTime和endTime成对使用，且时间间隔不超过31天	1667815639
endTime	否	Integer	查询结束Unix时间戳， startTime和endTime成对使用，且时间间隔不超过31天	1667817639
fun	否	String	本参数表示聚合类型。默认值为avg。取值范围:raw：原始值。avg：平均值。min：最小值。max：最大值。variance：方差。sum：求和。根据以上范围取值。	avg
period	否	Integer	聚合周期，单位：秒，默认300，需不小于60，推荐使用60的整倍数。当fun为raw时本参数无效。	300

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败），默认值：800	800
errorCode	String	失败时的错误代码，参见公共错误码说明
message	String	失败时的错误描述，一般为英文描述	Success
msgDesc	String	失败时的错误描述，适配中英文	成功
description	String	失败时的错误描述，适配中英文	成功
error	String	错误码，请求成功时，不返回该字段	Openapi.Parameter.Error
returnObj	Object	返回对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
viewID	String	视图ID	5ac245b3-dd9b-75c3-cee5-d1b674bb0d69
viewType	String	视图类型。取值范围:timeSeries：折线图。gauge：仪表盘。barChart：柱状图。table：表格。pieChart：饼状图。根据以上范围取值。	timeSeries
monitorType	String	视图属性。取值范围:metric：指标。resource：实例。根据以上范围取值。	metric
viewData	Object	数据		viewDataObj

表 viewDataObj

参数	参数类型	说明	示例	下级对象
timeSeriesData	Array of Objects	折线图数据		timeSeriesDataObj
barChartData	Array of Objects	柱状图数据		barChartDataObj
gaugeData	Object	仪表盘数据		gaugeDataObj
pieChartData	Object	饼状图数据		pieChartDataObj
tableData	Object	表格数据		tableDataObj

表 timeSeriesDataObj

参数	参数类型	说明	示例	下级对象
itemName	String	监控项名称	cpu_util
itemDesc	String	监控项中文介绍	CPU使用率
itemUnit	String	监控项单位	%
compareType	String	本参数表示比较类型。取值范围:1d：环比。7d：同比。0d：原始。根据以上范围取值。	1d
itemData	Array of Objects	折线图数据		itemDataTimeSeries
dimensions	Array of Objects	监控项标签		dimension
resource	Array of Objects	资源		obj

表 itemDataTimeSeries

参数	参数类型	说明	示例	下级对象
value	Double	监控项值，具体请参考对应监控项文档	524288
timestamp	Integer	监控数据Unix时间戳	1667815639

表 barChartDataObj

参数	参数类型	说明	示例	下级对象
itemName	String	监控项名称	cpu_util
itemDesc	String	监控项中文介绍	CPU使用率
itemUnit	String	监控项单位	%
compareType	String	本参数表示比较类型。取值范围:1d：环比。7d：同比。0d：原始。根据以上范围取值。	1d
itemData	Array of Objects	柱状图数据		itemDataBarChart
dimensions	Array of Objects	监控项标签		dimension
resource	Array of Objects	资源		obj

表 itemDataBarChart

参数	参数类型	说明	示例	下级对象
value	Double	监控项值，具体请参考对应监控项文档	524288
timestamp	Integer	监控数据Unix时间戳	1667815639

表 gaugeDataObj

参数	参数类型	说明	示例	下级对象
itemName	String	监控项名称	cpu_util
itemDesc	String	监控项中文介绍	CPU使用率
itemUnit	String	监控项单位	%
rawValue	String	监控项原始值	85
compareData	Array of Objects	比较数据		compareDataObj
minValue	Integer	表盘最小值	0
maxValue	Integer	表盘最大值	100
threshold	Array of Integers	表盘阈值	[30,80]
resource	Array of Objects	资源		obj

表 pieChartDataObj

参数	参数类型	说明	示例	下级对象
itemName	String	监控项名称	cpu_util
itemDesc	String	监控项中文介绍	CPU使用率
itemUnit	String	监控项单位	%
itemData	Array of Objects	饼图数据		itemDataPieChart

表 itemDataPieChart

参数	参数类型	说明	示例	下级对象
rawValue	Double	监控项原始值	85
compareData	Array of Objects	比较数据		compareDataObj
resource	Array of Objects	资源		obj
proportion	String	占比	85

表 tableDataObj

参数	参数类型	说明	示例	下级对象
tableHead	Array of Strings	表头	['名称']
itemData	Array of Objects	表格数据		itemDataTable

表 itemDataTable

参数	参数类型	说明	示例	下级对象
service	String	服务	ecs
dimension	String	维度	ecs
dimensions	Array of Objects	监控项标签		dimension
timestamp	Integer	监控数据Unix时间戳	1667815639
itemName	String	监控项名称	cpu_util
itemDesc	String	监控项中文介绍	CPU使用率
itemUnit	String	监控项单位	%
rawValue	Double	监控项原始值	85
compareData	Array of Objects	比较数据		compareDataObj
resource	Array of Objects	资源		obj

表 compareDataObj

参数	参数类型	说明	示例	下级对象
value	String	监控项值，具体请参考对应监控项文档	524288
compareType	String	本参数表示比较类型。取值范围:1d：环比。7d：同比。根据以上范围取值。	1d

表 obj

参数	参数类型	说明	示例	下级对象
key	String	资源键	uuid
value	String	资源键对应的值	xxxx

表 dimension

参数	参数类型	说明	示例	下级对象
name	String	监控项标签键	uuid
value	String	监控项标签键对应的值	9dc48979-4e19-45e2-b523-5d3c70d516b3

请求示例

请求url

/v4/monitor/monitor-board/query-view-data

请求头header

无

请求体body

{
    "regionID":"81f7728662dd11ec810800155d307d5b",
    "viewID":"fb33ae47-415f-4026-23ad-c8492a667e9c",
    "startTime":1665305264,
    "endTime":1665391665,
    "fun":"avg",
    "period":300
}

响应示例

折线图示例
{
    "statusCode":800,
    "returnObj":{
        "viewID":"5ac245b3-dd9b-75c3-cee5-d1b674bb0d69",
        "viewType":"timeSeries",
        "monitorType":"resource",
        "viewData":{
            "timeSeriesData":[
                {
                    "itemName":"mem_util",
                    "itemDesc":"内存使用率",
                    "itemUnit":"%",
                    "compareType":"0d",
                    "itemData":[
                        {
                            "value":20.971920186184,
                            "timestamp":1711674090
                        },
                        {
                            "value":20.955610239977997,
                            "timestamp":1711674390
                        }
                    ],
                    "dimensions":[
                        {
                            "name":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ],
                    "resource":[
                        {
                            "key":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ]
                },
                {
                    "itemName":"cpu_util",
                    "itemDesc":"CPU使用率",
                    "itemUnit":"%",
                    "compareType":"0d",
                    "itemData":[
                        {
                            "value":1.0480094529505,
                            "timestamp":1711674090
                        },
                        {
                            "value":0.9793189884861999,
                            "timestamp":1711674390
                        }
                    ],
                    "dimensions":[
                        {
                            "name":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ],
                    "resource":[
                        {
                            "key":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ]
                }
            ],
            "barChartData":[

            ],
            "gaugeData":{

            },
            "pieChartData":{

            },
            "formData":{

            }
        }
    },
    "errorCode":"",
    "message":"Success",
    "msgDesc":"成功",
    "description": "成功"
}

柱状图示例
{
    "statusCode":800,
    "returnObj":{
        "viewID":"4bb245b3-dd9b-75c3-cee5-d1b674bb0d69",
        "viewType":"barChart",
        "monitorType":"resource",
        "viewData":{
            "timeSeriesData":[

            ],
            "barChartData":[
                {
                    "itemName":"mem_util",
                    "itemDesc":"内存使用率",
                    "itemUnit":"%",
                    "compareType":"0d",
                    "itemData":[
                        {
                            "value":20.971920186184,
                            "timestamp":1711674090
                        },
                        {
                            "value":20.955610239977997,
                            "timestamp":1711674390
                        }
                    ],
                    "dimensions":[
                        {
                            "name":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ],
                    "resource":[
                        {
                            "key":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ]
                },
                {
                    "itemName":"cpu_util",
                    "itemDesc":"CPU使用率",
                    "itemUnit":"%",
                    "compareType":"0d",
                    "itemData":[
                        {
                            "value":1.0480094529505,
                            "timestamp":1711674090
                        },
                        {
                            "value":0.9793189884861999,
                            "timestamp":1711674390
                        }
                    ],
                    "dimensions":[
                        {
                            "name":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ],
                    "resource":[
                        {
                            "key":"uuid",
                            "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                        }
                    ]
                }
            ],
            "gaugeData":{

            },
            "pieChartData":{

            },
            "tableData":{

            }
        }
    },
    "errorCode":"",
    "message":"Success",
    "msgDesc":"成功",
    "description": "成功"
}

仪表盘数据
{
    "statusCode":800,
    "returnObj":{
        "viewID":"7aa245b3-dd9b-75c3-cee5-d1b674bb0d69",
        "viewType":"gauge",
        "monitorType":"resource",
        "viewData":{
            "timeSeriesData":[

            ],
            "barChartData":[

            ],
            "gaugeData":{
                "itemName":"cpu_util",
                "itemDesc":"CPU使用率",
                "itemUnit":"%",
                "rawValue":"0.95",
                "compareData":[
                    {
                        "compareType":"1d",
                        "value":"-2.65"
                    },
                    {
                        "compareType":"7d",
                        "value":"-1.40"
                    }
                ],
                "minValue":0,
                "maxValue":100,
                "threshold":[
                    30,
                    80
                ],
                "resource":[
                    {
                        "key":"uuid",
                        "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                    }
                ]
            },
            "pieChartData":{

            },
            "tableData":{

            }
        }
    },
    "errorCode":"",
    "message":"Success",
    "msgDesc":"成功",
    "description": "成功"
}

饼图
{
    "statusCode":800,
    "returnObj":{
        "viewID":"3tt245b3-dd9b-75c3-cee5-d1b674bb0d69",
        "viewType":"pieChart",
        "monitorType":"metric",
        "viewData":{
            "timeSeriesData":[

            ],
            "barChartData":[

            ],
            "gaugeData":{

            },
            "pieChartData":{
                "itemName":"cpu_util",
                "itemDesc":"CPU使用率",
                "itemUnit":"%",
                "itemData":[
                    {
                        "rawValue":0.9765625,
                        "compareData":[
                            {
                                "compareType":"1d",
                                "value":"0.01"
                            },
                            {
                                "compareType":"7d",
                                "value":"-11.72"
                            }
                        ],
                        "resource":[
                            {
                                "key":"uuid",
                                "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                            }
                        ],
                        "proportion":"8.88"
                    },
                    {
                        "rawValue":10.020822488287,
                        "compareData":[
                            {
                                "compareType":"1d",
                                "value":""
                            },
                            {
                                "compareType":"7d",
                                "value":"64.87"
                            }
                        ],
                        "resource":[
                            {
                                "key":"uuid",
                                "value":"1b17707d-d067-cda6-011f-b0bd6b456f78"
                            }
                        ],
                        "proportion":"91.12"
                    }
                ]
            },
            "tableData":{

            }
        }
    },
    "errorCode":"",
    "message":"Success",
    "msgDesc":"成功",
    "description": "成功"
}

表格
{
    "statusCode":800,
    "returnObj":{
        "viewID":"2ab245b3-dd9b-75c3-cee5-d1b674bb0d69",
        "viewType":"table",
        "monitorType":"resource",
        "viewData":{
            "timeSeriesData":[

            ],
            "barChartData":[

            ],
            "gaugeData":{

            },
            "pieChartData":{

            },
            "tableData":{
                "tableHead":[
                    "资源类型",
                    "实例名称/id",
                    "时间",
                    "指标",
                    "数值",
                    "环比",
                    "同比"
                ],
                "itemData":[
                    {
                        "service":"ecs",
                        "dimension":"ecs",
                        "timestamp":1711674090,
                        "itemName":"cpu_util",
                        "itemDesc":"CPU使用率",
                        "itemUnit":"%",
                        "rawValue":"0.95",
                        "compareData":[
                            {
                                "compareType":"1d",
                                "value":"-2.65"
                            },
                            {
                                "compareType":"7d",
                                "value":"-1.40"
                            }
                        ],
                        "resource":[
                            {
                                "key":"uuid",
                                "value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
                            }
                        ]
                    }
                ]
            }
        }
    },
    "errorCode":"",
    "message":"Success",
    "msgDesc":"成功",
    "description": "成功"
}

状态码

状态码	描述
200	请求成功

错误码

errorCode	描述
Monitor.MonitorBoard.ViewNotExist	视图不存在
Monitor.DataQuery.AccessFailed	访问内部系统失败
Monitor.DataQuery.ResponseError	访问内部系统返回错误
其他	参见公共错误码说明