响应示例 状态码： 200 OK，请求响应成功。 { "instance_info_list" : [ { "instance_id" : 15, "business_name" : null, "business_id" : null, "app_name" : null, "host_name" : "apm2-apm-pu-task-6b5bbfc84d-rxlhr", "instance_name" : "default", "ip_address" : "*.*.*.*", "env_id" : null, "agent_version" : "2.2.8", "last_heartbeat" : 1666682386000, "register_time" : 1666664387000, "last_modify_user_id" : null, "instance_status" : 0, "last_modify_user_name" : null, "last_modify_time" : 0 }, { "instance_id" : 16, "business_name" : null, "business_id" : null, "app_name" : null, "host_name" : "apm2-apm-pu-task-6b5bbfc84d-gtrrs", "instance_name" : "default", "ip_address" : "*.*.*.*", "env_id" : null, "agent_version" : "2.2.8", "last_heartbeat" : 1666682377000, "register_time" : 1666664436000, "last_modify_user_id" : null, "instance_status" : 0, "last_modify_user_name" : null, "last_modify_time" : 0 } ], "total_count" : 2, "online_count" : 0, "offline_count" : 0, "disable_count" : 0 }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 x-business-id 是 Long 应用id。 表2 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 Long 环境id。 page 是 Integer 当前页码。 page_size 否 Integer 每页数据容量。 keyword 否 String 关键字。 status 否 Integer 实例状态。 return_count 否 Boolean 是否返回计数结果。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_info_list Array of InstanceInfo objects 实例信息列表。 total_count Integer 实例总数。 online_count Integer 在线实例总数。 offline_count Integer 离线实例总数。 disable_count Integer 停止实例总数。 表4 InstanceInfo 参数 参数类型 描述 instance_id Long 实例id。 business_name String 应用名称。 business_id Long 应用id。 app_name String 组件名称。 host_name String 主机名称。 instance_name String 实例名称。 ip_address String 主机ip地址。 env_id Long 环境ID。 agent_version String Javaagent版本。 last_heartbeat Long 最后心跳时间。 register_time Long 注册时间。 last_modify_user_id String 最后修改用户id。 instance_status Integer 实例状态。 last_modify_user_name String 最后修改用户名称。 last_modify_time Long 最后修改时间。

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "active": false, "application": null, "belongTo": "000f000001DHIByJ3nKC", "belongTo.__objectType": "Application", "belongTo.name": "", "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-05-22 16:02:55", "custom": true, "customStyle": null, "description": null, "events": [{ "action": "[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.formSave()\\r\\n\"}}]", "belongTo": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-05-22 16:02:55", "custom": true, "id": "003h000001DHkGa8bjhA", "installedPackage": null, "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-05-22 16:02:55", "name": "button_0_click", "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "protectMode": 0, "view": "003g000001DHkGa4LkkC", "view.__objectType": "View", "view.name": "__layout__Test__ApprovedResource__ CS T__detail", "visibility": 0 }, { "action": "[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.resetFields()\\r\\n\"}}]", "belongTo": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-05-22 16:02:55", "custom": true, "id": "003h000001DHkGa8tKpE", "installedPackage": null, "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-05-22 16:02:55", "name": "button_1_click", "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "protectMode": 0, "view": "003g000001DHkGa4LkkC", "view.__objectType": "View", "view.name": "__layout__Test__ApprovedResource__CST__detail", "visibility": 0 } ], "id": "003g000001DHkGa4LkkC", "installedPackage": null, "label": "Test__ApprovedResource__CST Detail", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-05-22 16:02:55", "layer": "null", "libraries": "[]", "lockTime": "", "lockUser": "", "logo": null, "name": "__layout__Test__ApprovedResource__CST__detail", "overridable": true, "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "pageType": null, "protectMode": 0, "referencePageId": null, "type": "Page", "version": "1.0.1", "viewData": "{\"key\":1,\"type\":\"DesignerPage\",\"props\":{\"name\":\"DesignerPage_1\"},\"elements\":[{\"key\":1538107283948000,\"type\":\"form\",\"props\":{\"labelPosition\":\"top\",\"labelWidth\":120,\"name\":\"form_0\",\"dataSource\":\"Test__ApprovedResource__CST\",\"dataSourceType\":\"Entity\",\"layout\":{\"key\":\"one_one_one\",\"value\":[8,8,8]},\"dataSourceId\":\"Test__ApprovedResource__CST\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1535715199303019,\"type\":\"title\",\"props\":{\"text\":\"ApprovedResource\",\"value\":\"ApprovedResource\",\"class\":\"form-title-container\",\"name\":\"title_1\"},\"attrs\":{},\"on\":{},\"elements\":[]},{\"key\":1535715199303039,\"type\":\"container\",\"props\":{\"name\":\"container_1\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1535715199303036,\"type\":\"layoutgrid\",\"props\":{\"name\":\"layoutgrid_1\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1888001472428500,\"type\":\"row\",\"props\":{\"layout\":{\"pc\":{\"key\":\"one_one_one\",\"value\":[8,8,8]},\"pad\":{\"key\":\"pad1\",\"value\":[24]},\"phone\":{\"key\":\"phone1\",\"value\":[24]}},\"name\":\"row_0\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1888001472428501,\"type\":\"col\",\"props\":{\"align\":\"left\",\"lg\":8,\"md\":8,\"sm\":24,\"xs\":24,\"name\":\"col_3\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1888001472428502,\"dataBinding\":{\"default\":{\"model\":[\"form_0\",\"name\"]}},\"type\":\"input\",\"props\":{\"type\":\"text\",\"dataField\":\"name\",\"dataFieldType\":\"xs_string\",\"label\":\"{\\\"en_US\\\":\\\"Name\\\",\\\"zh_CN\\\":\\\"名称\\\"}\",\"name\":\"input_1716364974936\",\"readonly\":false}}]}]}]},{\"key\":1535946611880038,\"type\":\"container\",\"props\":{\"align\":\"center\",\"class\":\"form-buttons-container\",\"name\":\"container_1\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1535946611880036,\"type\":\"button\",\"props\":{\"text\":\"{\\\"en_US\\\":\\\"Save\\\",\\\"fr_FR\\\":\\\"\\\",\\\"ja_JP\\\":\\\"\\\",\\\"zh_CN\\\":\\\"保存\\\"}\",\"style\":\"margin-right:20px;\",\"type\":\"primary\",\"name\":\"button_0\"},\"attrs\":{},\"on\":{\"click\":{\"actions\":[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.formSave()\\r\\n\"}}],\"graph\":\"\",\"serviceList\":[]}},\"elements\":[]},{\"key\":1535946611880037,\"type\":\"button\",\"props\":{\"text\":\"{\\\"en_US\\\":\\\"Reset\\\",\\\"fr_FR\\\":\\\"\\\",\\\"ja_JP\\\":\\\"\\\",\\\"zh_CN\\\":\\\"重置\\\"}\",\"style\":\"\",\"name\":\"button_1\"},\"attrs\":{},\"on\":{\"click\":{\"actions\":[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.resetFields()\\r\\n\"}}],\"graph\":\"\",\"serviceList\":[]}},\"elements\":[]}]}]}],\"dataBinding\":{\"default\":{\"model\":[\"form_0\"]}}}],\"dependencies\":[{\"names\":{\"extendNames\":[],\"pageMasterNames\":[],\"cardNames\":[]}}],\"version\":\"1.0.2\"}", "viewModel": "{\"form_0\":{\"mapping\":[{\"bindType\":\"object\",\"bindName\":\"Test__ApprovedResource__CST\",\"include\":\"ALL\",\"exclude\":\"\"}],\"fields\":[{\"name\":\"form_0\",\"label\":\"form_0\",\"type\":\"object\",\"isRequired\":false,\"defaultValue\":{},\"expand\":false,\"orign\":[{\"type\":\"Test__ApprovedResource__CST\",\"name\":\"Test__ApprovedResource__CST\",\"mappingField\":\"Test__ApprovedResource__CST\"}],\"rootInstanceId\":\"form_0\",\"_uid\":0},{\"name\":\"name\",\"label\":\"{\\\"en_US\\\":\\\"Name\\\",\\\"zh_CN\\\":\\\"名称\\\"}\",\"type\":\"xs_string\",\"orign\":[{\"type\":\"object\",\"name\":\"Test__ApprovedResource__CST\",\"mappingField\":\"name\"}],\"parentId\":\"form_0\",\"expand\":false,\"rootInstanceId\":\"form_0\",\"_uid\":1}],\"actions\":[{\"name\":\"query\",\"type\":\"object\",\"method\":\"query\",\"uri\":\"Test__ApprovedResource__CST\",\"input\":[],\"output\":[{\"fieldName\":\"name\",\"mappingField\":\"name\"}]},{\"name\":\"save\",\"type\":\"object\",\"method\":\"save\",\"uri\":\"Test__ApprovedResource__CST\",\"output\":[],\"input\":[{\"fieldName\":\"name\",\"mappingField\":\"name\"}]},{\"name\":\"delete\",\"type\":\"object\",\"method\":\"delete\",\"uri\":\"Test__ApprovedResource__CST\",\"output\":[],\"input\":[{\"fieldName\":\"name\",\"mappingField\":\"name\"}]},{\"name\":\"count\",\"type\":\"object\",\"method\":\"count\",\"uri\":\"Test__ApprovedResource__CST\",\"input\":[],\"output\":[]}]}}", "visibility": 0 } }

响应示例 状态码： 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 表3 响应Body参数 参数 参数类型 描述 title String 标题。 collector_name String 采集器名称。 view_row_list Array of ViewRow objects 视图的列表，内部每个List代表的是一行图表。 style String 类型。 表4 ViewRow 参数 参数类型 描述 view_list Array of ViewBase objects 视图行，包含多个视图，展示的时候根据实际的长度适配。 title String 标题。 表5 ViewBase 参数 参数类型 描述 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 Boolean span信息。 span_field String span字段属性。 order_by String 排序规则。 latest Boolean 是否只展示最近一笔数据。 view_type String 视图类型。 枚举值： trend sumtable rawtable 表6 FieldItem 参数 参数类型 描述 function String 表达式。 as String 作为。 default_value String 默认值。 trace Boolean 是否是trace。 precision Integer 百分比。 unit String 单位。 visible Boolean 是否可见。

请求示例 分页查询region ID为xxx-roma-2，应用ID为162，指定起止时间的span数据。 /v1/apm2/openapi/view/trace/span-search { "region" : "xxx-roma-2", "biz_id" : 162, "page" : 1, "page_size" : 15, "start_time_string" : "2022-10-25 10:03:16", "end_time_string" : "2022-10-25 10:23:16", "codes" : [ ] }

响应示例 状态码： 200 OK，请求响应成功。 { "total" : 2, "span_info_list" : [ { "async" : false, "global_trace_id" : "16-1666684411910-1326", "global_path" : null, "trace_id" : "16-1666684411910-1326", "span_id" : "1", "env_id" : 11, "instance_id" : 16, "app_id" : 11, "biz_id" : 162, "domain_id" : 1, "source" : "/apm2/health/v1/health-check", "real_source" : "/apm2/health/v1/health-check", "start_time" : 1666684411910, "time_used" : 1, "code" : 200, "class_name" : "org/apache/catalina/core/StandardHostValve", "is_async" : false, "tags" : { }, "has_error" : false, "error_reasons" : null, "type" : "Tomcat", "http_method" : "GET", "estimated_start_time" : null, "estimated_end_time" : null, "biz_code" : null, "env_name" : "xxx-roma-2", "instance_name" : "apm2-apm-pu-task-6b5bbfc84d-gtrrs(172.16.3.7)", "app_name" : "apm-pu-task", "region" : "xxx-roma-2" }, { "async" : false, "global_trace_id" : "15-1666684400114-1332", "global_path" : null, "trace_id" : "15-1666684400114-1332", "span_id" : "1", "env_id" : 11, "instance_id" : 15, "app_id" : 11, "biz_id" : 162, "domain_id" : 1, "source" : "/apm2/health/v1/health-check", "real_source" : "/apm2/health/v1/health-check", "start_time" : 1666684400114, "time_used" : 0, "code" : 200, "class_name" : "org/apache/catalina/core/StandardHostValve", "is_async" : false, "tags" : { }, "has_error" : false, "error_reasons" : null, "type" : "Tomcat", "http_method" : "GET", "estimated_start_time" : null, "estimated_end_time" : null, "biz_code" : null, "env_name" : "xxx-roma-2", "instance_name" : "apm2-apm-pu-task-6b5bbfc84d-rxlhr(*.*.*.*)", "app_name" : "apm-pu-task", "region" : "xxx-roma-2" } ] }

响应示例 状态码： 200 OK，请求响应成功。 { "line_list" : [ { "point_list" : [ { "time" : 1666682400000, "value" : 8 }, { "time" : 1666682460000, "value" : 8 }, { "time" : 1666682520000, "value" : 8 }, { "time" : 1666682580000, "value" : 8 }, { "time" : 1666682640000, "value" : 8 }, { "time" : 1666682700000, "value" : 8 }, { "time" : 1666682760000, "value" : 8 }, { "time" : 1666682820000, "value" : 8 }, { "time" : 1666682880000, "value" : 8 }, { "time" : 1666682940000, "value" : 8 }, { "time" : 1666683000000, "value" : 8 }, { "time" : 1666683060000, "value" : 8 }, { "time" : 1666683120000, "value" : 8 }, { "time" : 1666683180000, "value" : 8 }, { "time" : 1666683240000, "value" : 8 }, { "time" : 1666683300000, "value" : 8 }, { "time" : 1666683360000, "value" : 8 }, { "time" : 1666683420000, "value" : null }, { "time" : 1666683480000, "value" : null }, { "time" : 1666683540000, "value" : null } ], "title" : "调用次数", "unit" : null, "precision" : null, "data_type" : "INT", "visible" : true } ], "latest_data_Time" : 1666683360000 }

请求示例 获取趋势图。入参中，view_type对应的值是trend。 /v1/apm2/openapi/view/metric/trend { "end_time" : "2022-10-25 15:40:00", "env_id" : "11", "monitor_item_id" : 78, "start_time" : "2022-10-25 15:20:00", "view_config" : { "latest" : null, "span" : true, "collector_name" : "Url", "metric_set" : "url", "title" : "调用次数", "table_direction" : null, "group_by" : "", "filter" : "url=/apm2/health/v1/health-check^method=GET", "field_item_list" : [ { "trace" : null, "function" : "SUM(invokeCount)", "as" : "调用次数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true } ], "span_field" : "source", "view_type" : "trend" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 line_list Array of FrontLine objects 趋势图数据列表。 latest_data_Time Long 最后日期时间。 表6 FrontLine 参数 参数类型 描述 point_list Array of FrontPoint objects 数据点集合。 title String 标题。 unit String 单位。 precision Integer 百分比。 data_type String 日期类型。 visible Boolean 是否可见。 表7 FrontPoint 参数 参数类型 描述 time Long 时间。 value Object 值。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-business-id 是 Long 应用id。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 表2 请求Body参数 参数 是否必选 参数类型 描述 view_config 是 TrendView object 视图配置信息。 instance_id 否 Long 实例id。 monitor_item_id 否 Long 监控项id。 env_id 是 Long 环境id。 start_time 是 String 开始时间。 end_time 是 String 结束时间。 表3 TrendView 参数 是否必选 参数类型 描述 view_type 否 String 视图类型。 枚举值： trend sumtable rawtable 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 否 Boolean 跨度。 span_field 否 String span字段属性。 order_by 否 String 排序。 latest 否 String 是否只展示最近一笔数据。 表4 FieldItem 参数 是否必选 参数类型 描述 function 是 String 表达式。 as 否 String 作为。 default_value 否 String 默认值。 trace 否 Boolean 是否是trace。 precision 否 Integer 百分比。 unit 否 String 单位。 visible 否 Boolean 是否可见。