Obtaining the Monitoring Item Information

Function

This API is used to obtain the monitoring item information.

URI

GET /v1/apm2/openapi/view/mainview/get-env-monitor-item-list

Table 1 Query Parameters
Parameter	Mandatory	Type	Description
env_id	Yes	Long	Environment ID.

Request Parameters

Table 2 Request header parameters
Parameter	Mandatory	Type	Description
x-business-id	Yes	Long	Application ID.
X-Auth-Token	Yes	String	User token obtained from IAM.

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
category_info_list	Array of CollectorCategoryInfo objects	Collector type set.
monitor_item_info_list	Array of MonitorItemEntity objects	Monitoring item set.

Table 4 CollectorCategoryInfo
Parameter	Type	Description
category_id	Integer	Collector type ID.
category_name	String	Collector type name.
display_name	String	Display name of a collector type.
sequence	Integer	Sequence number.

Table 5 MonitorItemEntity
Parameter	Type	Description
category_id	Integer	Collector type ID.
collector_name	String	Collector name.
display_name	String	Display name of a collector type.
show_in_total	Boolean	Whether to display the title.
monitor_item_id	Long	Monitoring item ID.
disabled	Boolean	Disable or not.
collector_id	Integer	Collector ID.
sequence	Integer	Sequence number.
collect_interval	Integer	Default data collection interval.

Example Requests

Obtain the monitoring item information in environment 11.

/v1/apm2/openapi/view/mainview/get-env-monitor-item-list?env_id=11

Example Responses

Status code: 200

OK: The request is successful.

{
  "category_info_list" : [ {
    "category_id" : 7,
    "category_name" : "Url",
    "display_name" : "URL",
    "sequence" : 1
  }, {
    "category_id" : 5,
    "category_name" : "Base",
    "display_name" : "JVM",
    "sequence" : 20
  }, {
    "category_id" : 4,
    "category_name" : "Exception",
    "display_name" : "Exception",
    "sequence" : 30
  }, {
    "category_id" : 11,
    "category_name" : "Web",
    "display_name" : "Web Containers",
    "sequence" : 80
  }, {
    "category_id" : 10,
    "category_name" : "ProbeInfo",
    "display_name" : "Agent Monitoring",
    "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 Monitoring",
    "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" : "JVMInfo",
    "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 Monitoring",
    "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 Monitoring",
    "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" : "Threads",
    "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 Method",
    "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" : "Exception Logs",
    "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 Monitoring",
    "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" : "Agent Monitoring",
    "show_in_total" : true
  } ]
}

Status Codes

Status Code	Description
200	OK: The request is successful.
400	Bad Request: Semantic or parameter error.
401	Unauthorized: No permissions.
403	Forbidden: Access forbidden.
404	Not Found: The requested resource is not found.

Error Codes

See Error Codes.

Parent topic: VIEW

Предыдущая статья

Obtaining the Instance Information

Следующая статья

AKSK

Была ли эта статья полезна?

Поддержка Юридические документы