获取链路追踪汇总表格数据(V2) - ShowSkywalkingMetricSumTable
功能介绍
获取链路追踪汇总表格数据。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm::getConf
Read
-
-
- apm:apm2BusinessView:get
- apm:apm2Service:get
-
URI
POST /v2/view/sw/metric/sum-table
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 |
| x-business-id | 是 | Long | 应用id。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_id | 否 | Long | 实例id。 |
| monitor_item_id | 否 | Long | 监控项id。 |
| env_id | 是 | Long | 环境id。 |
| start_time | 是 | String | 开始时间,毫秒级时间戳。 |
| end_time | 是 | String | 结束时间,毫秒级时间戳。 |
| page | 是 | Integer | 当前页码。 |
| page_size | 是 | Integer | 每页数据总数。 |
| order_by | 否 | String | 排序规则。 |
| search_word | 否 | String | 搜索关键字。 |
| request_id | 否 | String | 上次请求的id。 |
| view_config | 是 | SumTableView object | 视图配置信息。 |
| strategy | 否 | String | 策略。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| span | 否 | Boolean | 跨度。 |
| latest | 否 | Boolean | 是否只展示最近一笔数据。 |
| collector_name | 是 | String | 采集器名称。 |
| metric_set | 是 | String | 视图对应的指标集的名称。 |
| title | 否 | String | 图标所需展示的标题。 |
| table_direction | 否 | String | 表格的方向,H:默认,表头横向,V:表头纵向。 枚举值: H V |
| group_by | 否 | String | 分组规则。 |
| filter | 否 | String | 过滤列表模型。 |
| field_item_list | 是 | Array of FieldItem objects | 所需展示的字段列表模型列表。 |
| span_field | 否 | String | 跨度字段。 |
| order_by | 否 | String | 排序规则。 |
| view_type | 否 | String | 视图类型。 枚举值: trend sumtable rawtable |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result_id | String | 结果的ID信息,分页查询的时候带过来。 |
| row_list | Array of FrontRow_MetricSumTable objects | 数据行列表。 |
| latest_data_Time | Long | 最近一笔数据的时间。 |
| table_direction | String | 表格的方向,H:默认,表头横向,V:表头纵向。 枚举值: H V |
| real_start_time | Long | 实际开始的时间。 |
| real_end_time | Long | 实际结束的时间。 |
| notice_msg | String | 提示信息。 |
| total_count | Integer | 总数。 |
| metric_type | String | 指标类型。 |
| overview_title | String | 标题。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| header | Boolean | 是否是header信息。 |
| cell_list | Array of FrontCell objects | 数据单元集合。 |
| filter | String | 将group by的字段拼接成过滤字符串。 |
请求示例
/v2/view/sw/metric/sum-table
{
"end_time": 1767776243423,
"env_id": "1628822",
"page": 1,
"page_size": 10,
"start_time": 1767775943423,
"view_config": {
"span": true,
"collector_name": "swRpcClient",
"metric_set": "swRpcServer.url",
… }
],
"order_by": "2 desc",
"view_type": "sumtable"
},
"order_by": "2 desc"
} 响应示例
状态码:200
OK
{
"row_list" : [ {
"header" : true,
"cell_list" : [ {
"span" : true,
"trace" : false,
"data_type" : "ENUM",
"function" : "",
"text" : "url",
"visible" : true
}, {
"data_type" : "INT",
"function" : "SUM(invokeCount) as=调用次数",
"text" : "调用次数",
"visible" : true
}, {
"data_type" : "DOUBLE",
"function" : "SUM(totalTime)/SUM(invokeCount) as=平均耗时(ms)",
"text" : "平均耗时(ms)",
"visible" : true
}, {
"data_type" : "INT",
"function" : "MAX(maxTime) as=最大耗时(ms)",
"text" : "最大耗时(ms)",
"visible" : true
}, {
"data_type" : "INT",
"function" : "SUM(errorCount) as=错误次数",
"text" : "错误次数",
"visible" : true
}, {
"data_type" : "INT",
"function" : "SUM(slowCount) as=慢调用次数",
"text" : "慢调用次数",
"visible" : true
}, {
"trace" : true,
"data_type" : "STRING",
"function" : "LAST(slowTraceId) as=慢调用链 isTrace=true",
"text" : "慢调用链",
"visible" : true
}, {
"trace" : true,
"data_type" : "STRING",
"function" : "LAST(errorTraceId) as=错误调用链 isTrace=true",
"text" : "错误调用链",
"visible" : true
} ]
}, {
"header" : false,
"cell_list" : [ {
"text" : "POST /persistence/user",
"visible" : true
}, {
"text" : "13",
"visible" : true
}, {
"text" : "130681.77",
"visible" : true
}, {
"text" : "132267",
"visible" : true
}, {
"text" : "13",
"visible" : true
}, {
"text" : "13",
"visible" : true
}, {
"text" : "923334aa137f4242bb6bb9015502616f.98012.17677761691086643",
"visible" : true
}, {
"text" : "923334aa137f4242bb6bb9015502616f.98012.17677761691086643",
"visible" : true
} ],
"filter" : "url=POST /persistence/user"
}, {
"header" : false,
"cell_list" : [ {
"text" : "GET /persistence/products",
"visible" : true
}, {
"text" : "17",
"visible" : true
}, {
"text" : "129962.06",
"visible" : true
}, {
"text" : "132384",
"visible" : true
}, {
"text" : "17",
"visible" : true
}, {
"text" : "17",
"visible" : true
}, {
"text" : "923334aa137f4242bb6bb9015502616f.99630.17677762171200145",
"visible" : true
}, {
"text" : "923334aa137f4242bb6bb9015502616f.99630.17677762171200145",
"visible" : true
} ],
"filter" : "url=GET /persistence/products"
} ],
"latest_data_Time" : 0,
"table_direction" : "H",
"real_start_time" : 1767775943423,
"real_end_time" : 1767776243423,
"total_count" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 400 | Bad Request。 |
| 403 | Forbidden。 |
| 429 | Too Many Requests。 |
错误码
请参见错误码。