跳到主要内容

应用下组件实时监控

基本信息

该接口主要用于获取某个应用下组件 prometheus 的监控数据

请求路径
GET /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/monitor/query

请求参数

名称位置类型必选中文名说明
app_idpathinteger应用id
team_idpathstringnone
region_namepathstringnone
is_outerquerystring是否只获取对外组件监控

返回结果

状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

名称类型必选约束中文名说明
anonymous[ComponentMonitorSerializers]falsenonenone
» monitors[ComponentMonitorItemsSerializers]¦nullfalsenonenone
»» dataDatafalsenoneDatanone
»»» resultTypestringfalsenoneResulttype返回类型
»»» result[MonitorDataSerializers]truenonenone
»»»» value[string]truenonenone
»» monitor_itemstringtruenoneMonitor item监控项
»» statusstringfalsenoneStatus监控状态
» service_idstringtruenoneService id组件id
» service_cnamestringtruenoneService cname组件名
» service_aliasstringtruenoneService alias组件昵称
响应示例
[
{
"monitors": [
{
"data": {
"resultType": "vector",
"result": [
{
"value": [
"1655531430.126",
"0"
]
}
]
},
"monitor_item": "request_client",
"status": "success"
}
],
"service_id": "8377bede3b344e3daa96563a55516625",
"service_cname": "Mysql5.5(单机)",
"service_alias": "gr516625"
}
]

模型

ComponentMonitorSerializers

{
"monitors": [
{
"data": {
"resultType": "string",
"result": [
{
"value": null
}
]
},
"monitor_item": "string",
"status": "string"
}
],
"service_id": "string",
"service_cname": "string",
"service_alias": "string"
}

属性

名称类型必选约束中文名说明
monitors[ComponentMonitorItemsSerializers]¦nullfalsenonenone
service_idstringtruenoneService id组件id
service_cnamestringtruenoneService cname组件名
service_aliasstringtruenoneService alias组件昵称

ComponentMonitorItemsSerializers

{
"data": {
"resultType": "string",
"result": [
{
"value": [
"string"
]
}
]
},
"monitor_item": "string",
"status": "string"
}

属性

名称类型必选约束中文名说明
dataDatafalsenonenone
monitor_itemstringtruenoneMonitor item监控项
statusstringfalsenoneStatus监控状态

Data

{
"resultType": "string",
"result": [
{
"value": [
"string"
]
}
]
}

属性

名称类型必选约束中文名说明
resultTypestringfalsenoneResulttype返回类型
result[MonitorDataSerializers]truenonenone

MonitorDataSerializers

{
"value": [
"string"
]
}

属性

名称类型必选约束中文名说明
value[string]truenonenone