获取监控项信息- ShowEnvMonitorItems
功能介绍
获取监控项信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:getMonitorItemConf
Read
-
g:EnterpriseProjectId
apm:apm2BusinessMonitorItem:get
-
URI
GET /v1/apm2/openapi/view/mainview/get-env-monitor-item-list
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-business-id |
是 |
Long |
应用id。 |
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category_info_list |
Array of CollectorCategoryInfo objects |
采集器类别集合。 |
|
monitor_item_info_list |
Array of MonitorItemEntity objects |
监控项集合。 |
请求示例
获取环境ID为11的监控项信息。
/v1/apm2/openapi/view/mainview/get-env-monitor-item-list?env_id=11
响应示例
状态码: 200
OK,请求响应成功。
{
"category_info_list" : [ {
"category_id" : 7,
"category_name" : "Url",
"display_name" : "接口调用",
"sequence" : 1
}, {
"category_id" : 5,
"category_name" : "Base",
"display_name" : "基础监控",
"sequence" : 20
}, {
"category_id" : 4,
"category_name" : "Exception",
"display_name" : "异常",
"sequence" : 30
}, {
"category_id" : 11,
"category_name" : "Web",
"display_name" : "Web容器",
"sequence" : 80
}, {
"category_id" : 10,
"category_name" : "ProbeInfo",
"display_name" : "探针监控",
"sequence" : 90
} ],
"monitor_item_info_list" : [ {
"monitor_item_id" : 37,
"disabled" : false,
"collector_id" : 50,
"sequence" : 1,
"collect_interval" : 60,
"category_id" : 7,
"collector_name" : "Url",
"display_name" : "URL监控",
"show_in_total" : true
}, {
"monitor_item_id" : 16,
"disabled" : false,
"collector_id" : 36,
"sequence" : 5,
"collect_interval" : 60,
"category_id" : 5,
"collector_name" : "JVMInfo",
"display_name" : "JVM信息",
"show_in_total" : true
}, {
"monitor_item_id" : 14,
"disabled" : false,
"collector_id" : 28,
"sequence" : 10,
"collect_interval" : 60,
"category_id" : 5,
"collector_name" : "JVM",
"display_name" : "JVM监控",
"show_in_total" : true
}, {
"monitor_item_id" : 18,
"disabled" : false,
"collector_id" : 38,
"sequence" : 10,
"collect_interval" : 60,
"category_id" : 5,
"collector_name" : "GC",
"display_name" : "GC监控",
"show_in_total" : true
}, {
"monitor_item_id" : 20,
"disabled" : false,
"collector_id" : 48,
"sequence" : 10,
"collect_interval" : 60,
"category_id" : 5,
"collector_name" : "Thread",
"display_name" : "线程",
"show_in_total" : true
}, {
"monitor_item_id" : 13,
"disabled" : false,
"collector_id" : 20,
"sequence" : 15,
"collect_interval" : 60,
"category_id" : 5,
"collector_name" : "JavaMethod",
"display_name" : "JAVA方法",
"show_in_total" : true
}, {
"monitor_item_id" : 12,
"disabled" : false,
"collector_id" : 18,
"sequence" : 20,
"collect_interval" : 60,
"category_id" : 4,
"collector_name" : "Exception",
"display_name" : "异常日志",
"show_in_total" : true
}, {
"monitor_item_id" : 41,
"disabled" : false,
"collector_id" : 24,
"sequence" : 55,
"collect_interval" : 60,
"category_id" : 11,
"collector_name" : "Tomcat",
"display_name" : "Tomcat监控",
"show_in_total" : true
}, {
"monitor_item_id" : 11,
"disabled" : false,
"collector_id" : 16,
"sequence" : 60,
"collect_interval" : 60,
"category_id" : 10,
"collector_name" : "ProbeInfo",
"display_name" : "探针监控",
"show_in_total" : true
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK,请求响应成功。 |
|
400 |
Bad Request,语义或参数有误。 |
|
401 |
Unauthorized,没有权限。 |
|
403 |
Forbidden,禁止访问。 |
|
404 |
Not Found,没有找到要请求的资源。 |
错误码
请参见错误码。