文档首页/ 应用性能管理 APM/ API参考（2.0）/ API/ APM/ 查询监控项列表
更新时间：2023-09-08 GMT+08:00
查看PDF
分享

查询监控项列表

功能介绍

查询监控项列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/apm2/openapi/apm-service/monitor-item-mgr/get-env-monitor-item-list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

x-business-id

是

Long

应用id。
表2 请求Body参数

参数

是否必选

参数类型

描述

env_id

是

Long

环境id。

page

是

Integer

页码。

page_size

否

Integer

每页数量。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

monitor_item_list

Array of MonitorItem objects

监控项列表。

total_count

Integer

总数。

totalPage

Integer

总页数。
表4 MonitorItem

参数

参数类型

描述

id

Long

监控项id。

env_id

Long

环境id。

collector_id

Integer

采集器id。

collector_name

String

采集器名称。

display_name

String

采集器展示名称。

collect_interval

Integer

采集间隔。

disabled

Boolean

是否禁用。

status_change_user_id

String

修改采集状态用户id。

status_change_user_name

String

修改采集状态用户名称。

status_change_time

String

修改采集状态时间。

config_change_user_id

String

修改采集配置用户id。

config_change_user_name

String

修改采集配置用户名称。

config_change_time

String

修改采集配置时间。

请求示例

分页查询ID为913环境的监控项列表。

/v1/apm2/openapi/apm-service/monitor-item-mgr/get-env-monitor-item-list

{
  "env_id" : "913",
  "page" : 1,
  "page_size" : 10
}

响应示例

状态码： 200

OK，请求响应成功。

{
  "monitor_item_list" : [ {
    "id" : 55150,
    "env_id" : 913,
    "collector_id" : 61,
    "collector_name" : "Thread",
    "display_name" : "线程",
    "collect_interval" : 60,
    "disabled" : false,
    "status_change_user_id" : null,
    "status_change_user_name" : null,
    "status_change_time" : null,
    "config_change_user_id" : null,
    "config_change_user_name" : null,
    "config_change_time" : "2022-05-28 20:35:13"
  }, {
    "id" : 10509,
    "env_id" : 913,
    "collector_id" : 19,
    "collector_name" : "KafkaConsumer",
    "display_name" : "KafkaConsumer监控",
    "collect_interval" : 60,
    "disabled" : false,
    "status_change_user_id" : null,
    "status_change_user_name" : null,
    "status_change_time" : null,
    "config_change_user_id" : null,
    "config_change_user_name" : null,
    "config_change_time" : "2021-10-20 15:06:51"
  } ],
  "total_count" : 2,
  "total_page" : 1
}

状态码

状态码

描述

200

OK，请求响应成功。

400

Bad Request，语义或参数有误。

401

Unauthorized，没有权限。

403

Forbidden，禁止访问。

404

Not Found，没有找到要请求的资源。

错误码

请参见错误码。

父主题： APM

相关文档