应用下组件实时监控

基本信息

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

请求路径

  1. 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组件昵称

响应示例

  1. [
  2. {
  3. "monitors": [
  4. {
  5. "data": {
  6. "resultType": "vector",
  7. "result": [
  8. {
  9. "value": [
  10. "1655531430.126",
  11. "0"
  12. ]
  13. }
  14. ]
  15. },
  16. "monitor_item": "request_client",
  17. "status": "success"
  18. }
  19. ],
  20. "service_id": "8377bede3b344e3daa96563a55516625",
  21. "service_cname": "Mysql5.5(单机)",
  22. "service_alias": "gr516625"
  23. }
  24. ]

模型

ComponentMonitorSerializers

  1. {
  2. "monitors": [
  3. {
  4. "data": {
  5. "resultType": "string",
  6. "result": [
  7. {
  8. "value": null
  9. }
  10. ]
  11. },
  12. "monitor_item": "string",
  13. "status": "string"
  14. }
  15. ],
  16. "service_id": "string",
  17. "service_cname": "string",
  18. "service_alias": "string"
  19. }

属性

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

ComponentMonitorItemsSerializers

  1. {
  2. "data": {
  3. "resultType": "string",
  4. "result": [
  5. {
  6. "value": [
  7. "string"
  8. ]
  9. }
  10. ]
  11. },
  12. "monitor_item": "string",
  13. "status": "string"
  14. }

属性

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

Data

  1. {
  2. "resultType": "string",
  3. "result": [
  4. {
  5. "value": [
  6. "string"
  7. ]
  8. }
  9. ]
  10. }

属性

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

MonitorDataSerializers

  1. {
  2. "value": [
  3. "string"
  4. ]
  5. }

属性

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