You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
版本管理
ReleaseDetail
复制全文
下载 pdf
ReleaseDetail
获取指定版本的详情。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ReleaseDetail&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ReleaseDetail​
接口名称。当前 API 的名称为 ReleaseDetail。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
common​
Object of CommonParams​
是​
-​
通用参数。​
time_filter​
Object of TimeFilter​
是​
-​
时间区间。​
release​
String​
是​
v1.2.3​
版本号。​
env​
String​
是​
online​
版本发布环境。​
​
CommonParams​
​
参数​
类型​
是否必选​
示例值​
描述​
aid​
Long​
是​
12345​
应用ID。​
site_type​
String​
是​
web​
站点类型。​
env​
String​
是​
online​
环境,填""时为全部。​
os​
String​
否​
webpro​
服务类型,可选值为webpro,app,minipro。​
user​
String​
否​
test_user​
用户名。​
​
TimeFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
start_time​
Integer​
是​
1665485413​
起始时间,单位s。​
end_time​
Integer​
是​
1665744613​
终止时间,单位s。​
granularity​
Integer​
否​
3600​
聚合时间粒度,单位s。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ReleaseDetail&Version=2022-10-12​
{​
"common": {​
"aid": 12345,​
"site_type": "web",​
"env": "online",​
"user": "test_user",​
"os": "webpro"​
},​
"time_filter": {​
"start_time": 1665485413,​
"end_time": 1665744613,​
"granularity": 3600​
},​
"release": "v1.2.3",​
"env": "online"​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
-​
版本详情。​
error_msg​
String​
-​
错误信息,成功为空。​
error_no​
Integer​
0​
错误码,成功为0。​
​
ReleaseDetailResponseData​
​
参数​
类型​
示例值​
描述​
trend​
Object of ReleaseTrendInfo​
-​
指定版本的pv,uv,js错误数,js错误聚合issue数,新增js错误数,新增js聚合issue数变化趋势。​
jserr_info​
Object of ReleaseJSErrorInfo​
-​
指定版本js错误信息。​
overview_info​
Object of ReleaseOverviewInfo​
-​
指定版本总览信息。​
​
ReleaseTrendInfo​
​
参数​
类型​
示例值​
描述​
pv_uv​
Object of ChartData​
-​
pv/uv 返回两条线,代表pv/uv。​
err_count​
Object of ChartData​
-​
错误个数,返回两条线,代表新错误聚合issue数/总错误聚合issue数。​
err_times​
Object of ChartData​
-​
错误次数,返回两条线,代表新错误次数/总错误次数。​
​
ReleaseJSErrorInfo​
​
参数​
类型​
示例值​
描述​
new​
Array of NewJSErrorInfo​
-​
新增的js错误列表。​
fixed​
Array of FixedJSErrorInfo​
-​
已修复的js错误列表。​
​
ReleaseOverviewInfo​
​
参数​
类型​
示例值​
描述​
uv​
Long​
10​
独立访客数。​
env​
String​
online​
版本发布环境。​
version​
String​
v1.2.3​
版本号。​
created_at​
Long​
12345678​
版本创建时间。​
deployed_at​
Long​
12345678​
版本部署时间。​
jserr_count​
Long​
10​
js聚合issue数。​
jserr_times​
Long​
10​
js错误数。​
finalized_at​
Long​
12345678​
版本结束时间。​
new_jserr_count​
Long​
10​
新增js聚合issue数。​
new_jserr_times​
Long​
10​
新增js错误数。​
​
ChartData​
​
参数​
类型​
示例值​
描述​
fields​
Array of Field​
-​
折线图/饼图维度,len(fields)=len(source[i])。​
source​
Array of String​
[["1668355200","js_error","0","0"]]​
趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。​
​
NewJSErrorInfo​
​
参数​
类型​
示例值​
描述​
name​
String​
TypeError​
js错误类型。​
message​
String​
variable z not defined​
js错误信息。​
filename​
String​
12345.js​
报错文件名。​
issue_id​
String​
e2ed7046a625307277d8498b2cf0c11f​
js错误聚合id。​
​
FixedJSErrorInfo​
​
参数​
类型​
示例值​
描述​
name​
String​
TypeError​
js错误类型。​
message​
String​
variable z not defined​
js错误信息。​
filename​
String​
12345.js​
报错文件名。​
issue_id​
String​
e2ed7046a625307277d8498b2cf0c11f​
js错误聚合id。​
commit_url​
String​
-​
关联commit url。​
commit_message​
String​
-​
commit 信息,。​
​
Field​
​
参数​
类型​
示例值​
描述​
id​
String​
date​
维度key。​
name​
String​
日期​
维度名。​
dataType​
String​
string​
维度类型。​
aggregate​
String​
-​
聚合方式。​
​
返回示例​
​
{​
"error_no": 0,​
"error_msg": "",​
"data": {​
"overview_info": {​
"deployed_at": 12345678,​
"jserr_times": 10,​
"finalized_at": 12345678,​
"created_at": 12345678,​
"new_jserr_times": 10,​
"env": "online",​
"version": "v1.2.3",​
"jserr_count": 10,​
"new_jserr_count": 10,​
"uv": 10​
},​
"jserr_info": {​
"fixed_url": "",​
"new_url": "",​
"fixed": [​
{​
"filename": "12345.js",​
"commit_url": "",​
"issue_id": "e2ed7046a625307277d8498b2cf0c11f",​
"commit_message": "and",​
"name": "TypeError",​
"message": "variable z not defined"​
}​
],​
"new": [​
{​
"message": "variable z not defined",​
"filename": "12345.js",​
"name": "TypeError",​
"issue_id": "e2ed7046a625307277d8498b2cf0c11f"​
}​
]​
},​
"commit_info": [​
{​
"url": "situation",​
"time": 965,​
"author": "",​
"message": ""​
}​
],​
"trend": {​
"err_count": {​
"fields": [​
{​
"id": "date",​
"aggregate": "",​
"dataType": "string",​
"name": "date"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"err_times": {​
"fields": [​
{​
"name": "date",​
"id": "date",​
"dataType": "string",​
"aggregate": ""​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"pv_uv": {​
"fields": [​
{​
"id": "date",​
"aggregate": "",​
"dataType": "string",​
"name": "date"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
}​
}​
}​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:36
这个页面对您有帮助吗?
有用
有用
无用
无用