Obtaining the Details About a Monitoring Item

Function

This API is used to obtain the details about a monitoring item.

URI

GET /v1/apm2/openapi/apm-service/monitor-item-mgr/get-monitor-item-detail

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
monitor_item_id	Yes	Long	Monitored item ID
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
interval	String	Collection interval, in seconds.
collector_id	String	Collector ID.
config_item_list	Array of ConfigItemValue objects	Collection parameter configuration list.

**Table 4** ConfigItemValue
Parameter	Type	Description
config_name	String	Configuration item name.
display_name	String	Display name.
config_data_type	String	Data type.
max_length	Integer	Maximum length.
min_value	Double	Minimum value.
max_value	Double	Maximum value.
option_values	Array of OptionValue objects	Optional value.
default_value	String	Default value.
since_version	String	Start version.
dead_version	String	End version.
value	String	Value.
object_array_patterns	Array of object_array_patterns objects	An array of objects.
override_list	Array of ConfigItemOverride objects	Actual value.

**Table 5** OptionValue
Parameter	Type	Description
value	String	Optional value.
hint	String	Information.

**Table 6** object_array_patterns
Parameter	Type	Description
key	String	Key.
type	String	Object type.
max_length	Integer	Maximum length.
max_value	Double	Maximum value.
min_value	Double	Minimum value.
nullable	Boolean	Whether this parameter can be null or not.
hint	String	Information.

**Table 7** ConfigItemOverride
Parameter	Type	Description
env_tag_id	Long	Environment tag ID.
env_tag_name	String	Environment tag name.
key	String	Key.
value	String	Value.

Example Requests

Obtain details about monitoring item 5663 in environment 895.

/v1/apm2/openapi/apm-service/monitor-item-mgr/get-monitor-item-detail?env_id=895&monitor_item_id=5663

Example Responses

Status code: 200

OK: The request is successful.

{
  "interval" : 60,
  "collector_id" : 28,
  "config_item_list" : [ {
    "config_name" : "slowRequestThreshold",
    "display_name" : "Threshold for determining that a request is slow",
    "config_data_type" : "integer",
    "max_length" : null,
    "min_value" : 0,
    "max_value" : 20000,
    "option_values" : null,
    "default_value" : "800",
    "object_array_patterns" : null,
    "since_version" : "2.0.0",
    "dead_version" : null,
    "value" : null,
    "override_list" : null
  } ]
}

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.