获取一个监控项的详情- ShowMonitorItemDetail
功能介绍
获取一个监控项的详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:getMonitorItemConf
Read
-
g:EnterpriseProjectId
apm:apm2BusinessMonitorItem:get
-
URI
GET /v1/apm2/openapi/apm-service/monitor-item-mgr/get-monitor-item-detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
monitor_item_id |
是 |
Long |
监控项ID。 |
|
env_id |
是 |
Long |
环境ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-business-id |
是 |
Long |
应用id。 |
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
interval |
Integer |
采集间隔。 |
|
collector_id |
Integer |
采集器ID。 |
|
config_item_list |
Array of ConfigItemValue objects |
采集参数配置列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
config_name |
String |
配置项名字。 |
|
display_name |
String |
显示名称。 |
|
config_data_type |
String |
数据类型。 |
|
max_length |
Integer |
最大长度。 |
|
min_value |
Double |
最小值。 |
|
max_value |
Double |
最大值。 |
|
option_values |
Array of OptionValue objects |
可选值。 |
|
default_value |
String |
默认值。 |
|
since_version |
String |
开始版本。 |
|
dead_version |
String |
截止版本。 |
|
value |
String |
值。 |
|
object_array_patterns |
Array of object_array_patterns objects |
对象数组。 |
|
override_list |
Array of ConfigItemOverride objects |
实际生效值。 |
请求示例
获取环境ID为895,监控项ID为5663的监控项详情
/v1/apm2/openapi/apm-service/monitor-item-mgr/get-monitor-item-detail?env_id=895&monitor_item_id=5663
响应示例
状态码: 200
OK,请求响应成功。
{
"interval" : 60,
"collector_id" : 128,
"config_item_list" : [ {
"config_name" : "maxThreadDepth",
"display_name" : "线程详情最大行数",
"config_data_type" : "integer",
"max_length" : null,
"min_value" : 1,
"max_value" : 50,
"option_values" : null,
"default_value" : "10",
"object_array_patterns" : null,
"since_version" : "2.3.18",
"dead_version" : null,
"value" : null,
"override_list" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK,请求响应成功。 |
|
400 |
Bad Request,语义或参数有误。 |
|
401 |
Unauthorized,没有权限。 |
|
403 |
Forbidden,禁止访问。 |
|
404 |
Not Found,没有找到要请求的资源。 |
错误码
请参见错误码。