查询链路追踪指定监控项配置信息（V2） - ShowSkywalkingViewConfig

功能介绍

查询链路追踪指定监控项配置信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项
apm::getConf

Read

-

-

apm:apm2BusinessView:get

apm:apm2Service:get

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
apm::getConf	Read	-	-	apm:apm2BusinessView:get apm:apm2Service:get	-

URI

POST /v2/view/sw/config/get-view-config/{business_id}

表1 路径参数
参数	是否必选	参数类型	描述
business_id	是	Long	应用id。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token。
x-business-id	是	Long	应用id。

表3 请求Body参数
参数	是否必选	参数类型	描述
collector_name	是	String	采集器名称。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
title	String	标题。
collector_name	String	采集器名称。
view_row_list	Array of ViewRow objects	视图的列表，内部每个List代表的是一行图表。

表5 ViewRow
参数	参数类型	描述
view_list	Array of ViewBase objects	视图行，包含多个视图，展示的时候根据实际的长度适配。
title	String	标题。

表6 ViewBase
参数	参数类型	描述
span	Boolean	span信息。
collector_name	String	采集器名称。
metric_set	String	视图对应的指标集的名称。
title	String	图标所需展示的标题。
table_direction	String	表格的方向，H：默认，表头横向，V：表头纵向。枚举值： H V
group_by	String	分组规则。
filter	String	过滤列表模型。
field_item_list	FieldItem_ViewConfig object	所需展示的字段列表模型。
view_type	String	视图类型。
order_by	String	排序规则。

表7 FieldItem_ViewConfig
参数	参数类型	描述
function	String	函数。
as	String	名称。
visible	Boolean	是否可见。

请求示例

/v2/view/sw/config/get-view-config/5605872

{
  "collector_name" : "swRpcClient"
}

响应示例

状态码：200

{
  "title" : "接口调用",
  "collector_name" : "swRpcClient",
  "view_row_list" : [ {
    "view_list" : [ {
      "collector_name" : "swRpcClient",
      "metric_set" : "swRpcServer.total",
      "title" : "服务端概览",
      "filter" : "",
      "field_item_list" : [ {
        "function" : "SUM(invokeCount)",
        "as" : "调用次数",
        "visible" : true
      }, {
        "function" : "SUM(totalTime)/SUM(invokeCount)",
        "as" : "平均耗时(ms)",
        "visible" : true
      }, {
        "function" : "MAX(maxTime)",
        "as" : "最大耗时(ms)",
        "visible" : true
      }, {
        "function" : "SUM(errorCount)",
        "as" : "错误次数",
        "visible" : true
      } ],
      "view_type" : "trend"
    }, {
      "collector_name" : "swRpcClient",
      "metric_set" : "swRpcClient.total",
      "title" : "客户端概览",
      "filter" : "",
      "field_item_list" : [ {
        "function" : "SUM(invokeCount)",
        "as" : "调用次数",
        "visible" : true
      }, {
        "function" : "SUM(totalTime)/SUM(invokeCount)",
        "as" : "平均耗时(ms)",
        "visible" : true
      }, {
        "function" : "MAX(maxTime)",
        "as" : "最大耗时(ms)",
        "visible" : true
      }, {
        "function" : "SUM(errorCount)",
        "as" : "错误次数",
        "visible" : true
      } ],
      "view_type" : "trend"
    } ],
    "title" : ""
  }, {
    "view_list" : [ {
      "span" : true,
      "collector_name" : "swRpcClient",
      "metric_set" : "swRpcServer.url",
      "title" : "服务端接口维度统计",
      "group_by" : "url",
      "filter" : "",
      "field_item_list" : [ {
        "function" : "SUM(invokeCount)",
        "as" : "调用次数",
        "visible" : true
      }, {
        "function" : "SUM(totalTime)/SUM(invokeCount)",
        "as" : "平均耗时(ms)",
        "visible" : true
      }, {
        "function" : "MAX(maxTime)",
        "as" : "最大耗时(ms)",
        "visible" : true
      }, {
        "function" : "SUM(errorCount)",
        "as" : "错误次数",
        "visible" : true
      }, {
        "function" : "SUM(slowCount)",
        "as" : "慢调用次数",
        "visible" : true
      }, {
        "trace" : true,
        "function" : "LAST(slowTraceId)",
        "as" : "慢调用链",
        "visible" : true
      }, {
        "trace" : true,
        "function" : "LAST(errorTraceId)",
        "as" : "错误调用链",
        "visible" : true
      } ],
      "order_by" : "2 desc",
      "view_type" : "sumtable"
    } ],
    "title" : ""
  }, {
    "view_list" : [ {
      "collector_name" : "swRpcClient",
      "metric_set" : "swRpcClient.url",
      "title" : "客户端接口维度统计",
      "group_by" : "url",
      "filter" : "",
      "field_item_list" : [ {
        "function" : "SUM(invokeCount)",
        "as" : "调用次数",
        "visible" : true
      }, {
        "function" : "SUM(totalTime)/SUM(invokeCount)",
        "as" : "平均耗时(ms)",
        "visible" : true
      }, {
        "function" : "MAX(maxTime)",
        "as" : "最大耗时(ms)",
        "visible" : true
      }, {
        "function" : "SUM(errorCount)",
        "as" : "错误次数",
        "visible" : true
      }, {
        "function" : "SUM(slowCount)",
        "as" : "慢调用次数",
        "visible" : true
      }, {
        "trace" : true,
        "function" : "LAST(slowTraceId)",
        "as" : "慢调用链",
        "visible" : true
      }, {
        "trace" : true,
        "function" : "LAST(errorTraceId)",
        "as" : "错误调用链",
        "visible" : true
      } ],
      "order_by" : "2 desc",
      "view_type" : "sumtable"
    } ],
    "title" : ""
  } ]
}