更新时间:2023.04.11 16:29:04
调用ReleaseDetail接口获取指定版本的详情。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
common | object of common | 是 | - | 通用参数。 |
time_filter | object of time_filter | 是 | - | 时间区间。 |
release | string | 是 |
| 版本号。 |
env | string | 是 |
| 版本发布环境。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境,填""时为全部。 |
os | string | 否 |
| 服务类型,可选值为webpro,app,minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
start_time | i32 | 是 |
| 起始时间,单位s。 |
granularity | i32 | 否 |
| 聚合时间粒度,单位s。 |
end_time | i32 | 是 |
| 终止时间,单位s。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
data | object of data | - | 版本详情。 |
error_msg | string | - | 错误信息,成功为空。 |
error_no | i32 |
| 错误码,成功为0。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
overview_info | object of overview_info | - | 指定版本总览信息。 |
jserr_info | object of jserr_info | - | 指定版本js错误信息。 |
trend | object of trend | - | 指定版本的pv,uv,js错误数,js错误聚合issue数,新增js错误数,新增js聚合issue数变化趋势。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
version | string |
| 版本号。 |
env | string |
| 版本发布环境。 |
deployed_at | i64 |
| 版本部署时间。 |
created_at | i64 |
| 版本创建时间。 |
finalized_at | i64 |
| 版本结束时间。 |
uv | i64 |
| uv。 |
new_jserr_count | i64 |
| 新增js聚合issue数。 |
new_jserr_times | i64 |
| 新增js错误数。 |
jserr_count | i64 |
| js聚合issue数。 |
jserr_times | i64 |
| js错误数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fixed | array of fixed | - | 已修复的js错误列表。 |
new | array of new | - | 新增的js错误列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
pv_uv | object of pv_uv | - | pv/uv 返回两条线,代表pv/uv。 |
err_count | object of err_count | - | 错误个数,返回两条线,代表新错误聚合issue数/总错误聚合issue数。 |
err_times | object of err_times | - | 错误次数,返回两条线,代表新错误次数/总错误次数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
issue_id | string |
| js错误聚合ID。 |
name | string |
| js错误类型。 |
message | string |
| js错误信息 |
filename | string |
| 报错文件名。 |
commit_message | string | - | commit 信息,关联 commit url。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
issue_id | string |
| js错误聚合id。 |
name | string |
| js错误类型。 |
message | string |
| js错误信息。 |
filename | string |
| 报错文件名。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string |
| 维度key。 |
dataType | string |
| 维度类型。 |
name | string |
| 维度名。 |
aggregate | string | - | 聚合方式。 |
POST https://open.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" }
{ "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": "日期" } ], "source": [ [ "1668355200", "js_error", "0", "0" ] ] }, "err_times": { "fields": [ { "name": "日期", "id": "date", "dataType": "string", "aggregate": "" } ], "source": [ [ "1668355200", "js_error", "0", "0" ] ] }, "pv_uv": { "fields": [ { "id": "date", "aggregate": "", "dataType": "string", "name": "日期" } ], "source": [ [ "1668355200", "js_error", "0", "0" ] ] } } } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "ReleaseDetail", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }