更新时间：2024-05-20 GMT+08:00
查询监控项配置信息
功能介绍
查询监控项配置信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/apm2/openapi/view/config/get-monitor-item-view-config
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
env_id |
是 |
Long |
环境id。 |
collector_id |
是 |
Long |
采集器id。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
x-business-id |
是 |
Long |
应用id。 |
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
title |
String |
标题。 |
collector_name |
String |
采集器名称。 |
view_row_list |
Array of ViewRow objects |
视图的列表，内部每个List代表的是一行图表。 |
style |
String |
类型。 |
参数 |
参数类型 |
描述 |
|---|---|---|
view_list |
Array of ViewBase objects |
视图行，包含多个视图，展示的时候根据实际的长度适配。 |
title |
String |
标题。 |
参数 |
参数类型 |
描述 |
|---|---|---|
collector_name |
String |
采集器名称。 |
metric_set |
String |
视图对应的指标集的名称。 |
title |
String |
图标所需展示的标题。 |
table_direction |
String |
表格的方向，H：默认，表头横向，V：表头纵向。 枚举值：
|
group_by |
String |
分组规则。 |
filter |
String |
过滤列表模型。 |
field_item_list |
Array of FieldItem objects |
所需展示的字段列表模型。 |
span |
Boolean |
span信息。 |
span_field |
String |
span字段属性。 |
order_by |
String |
排序规则。 |
latest |
Boolean |
是否只展示最近一笔数据。 |
view_type |
String |
视图类型。 枚举值：
|
请求示例
查询环境ID为11、采集器ID为50的监控项配置信息。
/v1/apm2/openapi/view/config/get-monitor-item-view-config?env_id=11&collector_id=50
响应示例
状态码： 200
OK，请求响应成功。
{
"title" : "Url",
"collector_name" : "Url",
"view_row_list" : [ {
"view_list" : [ {
"latest" : null,
"span" : true,
"collector_name" : "Url",
"metric_set" : "url",
"title" : "接口维度汇总",
"table_direction" : null,
"group_by" : "url,method",
"filter" : "",
"field_item_list" : [ {
"trace" : null,
"function" : "SUM(invokeCount)",
"as" : "调用次数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(totalTime)/SUM(invokeCount)",
"as" : "平均响应时间(ms)",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(errorCount)",
"as" : "错误数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "MAX(concurrentMax)",
"as" : "最大并发",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "MAX(maxTime)",
"as" : "最慢调用(ms)",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(range1)",
"as" : "0ms-10ms",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : false
}, {
"trace" : null,
"function" : "SUM(range2)",
"as" : "10ms-100ms",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : false
}, {
"trace" : null,
"function" : "SUM(range3)",
"as" : "100ms-500ms",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : false
}, {
"trace" : null,
"function" : "SUM(range4)",
"as" : "500ms-1s",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : false
}, {
"trace" : null,
"function" : "SUM(range5)",
"as" : "1s-10s",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : false
}, {
"trace" : null,
"function" : "SUM(range6)",
"as" : "10s-n",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : false
} ],
"span_field" : "source",
"order_by" : null,
"view_type" : "sumtable"
} ],
"title" : ""
}, {
"view_list" : [ {
"latest" : null,
"span" : true,
"collector_name" : "Url",
"metric_set" : "statuscode",
"title" : "状态码维度汇总",
"table_direction" : null,
"group_by" : "code",
"filter" : "",
"field_item_list" : [ {
"trace" : null,
"function" : "SUM(count)",
"as" : "个数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "LAST(url)",
"as" : "最近url",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
} ],
"span_field" : "code",
"order_by" : null,
"view_type" : "sumtable"
} ],
"title" : ""
}, {
"view_list" : [ {
"latest" : null,
"span" : null,
"collector_name" : "Url",
"metric_set" : "user",
"title" : "集群维度汇总",
"table_direction" : null,
"group_by" : "clusterId",
"filter" : "",
"field_item_list" : [ {
"trace" : null,
"function" : "SUM(invokeCount)",
"as" : "调用次数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(totalTime)/SUM(invokeCount)",
"as" : "平均响应时间(ms)",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(errorCount)",
"as" : "错误数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
} ],
"span_field" : null,
"order_by" : null,
"view_type" : "sumtable"
} ],
"title" : ""
}, {
"view_list" : [ {
"latest" : null,
"span" : null,
"collector_name" : "Url",
"metric_set" : "total",
"title" : "总览",
"table_direction" : null,
"group_by" : "",
"filter" : "",
"field_item_list" : [ {
"trace" : null,
"function" : "SUM(invokeCount)",
"as" : "总请求数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(totalTime)/SUM(invokeCount)",
"as" : "平均响应时间(ms)",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
}, {
"trace" : null,
"function" : "SUM(errorCount)",
"as" : "错误次数",
"default_value" : null,
"precision" : null,
"unit" : null,
"visible" : true
} ],
"span_field" : null,
"order_by" : null,
"view_type" : "trend"
} ],
"title" : ""
} ],
"style" : "tab"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK，请求响应成功。 |
400 |
Bad Request，语义或参数有误。 |
401 |
Unauthorized，没有权限。 |
403 |
Forbidden，禁止访问。 |
404 |
Not Found，没有找到要请求的资源。 |
错误码
请参见错误码。
父主题： VIEW
