You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/版本管理/ReleaseDetail
ReleaseDetail
最近更新时间：2024.07.12 17:21:39首次发布时间：2022.11.18 15:32:34
我的收藏

获取指定版本的详情。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=ReleaseDetail&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是ReleaseDetail接口名称。当前 API 的名称为 ReleaseDetail。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

参数类型是否必选示例值描述
commonObject of CommonParams是-通用参数。
time_filterObject of TimeFilter是-时间区间。
releaseString是v1.2.3版本号。
envString是online版本发布环境。

CommonParams

参数类型是否必选示例值描述
aidLong是12345应用ID。
site_typeString是web站点类型。
envString是online环境，填""时为全部。
osString否webpro服务类型，可选值为webpro，app，minipro。
userString否test_user用户名。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger是1665485413起始时间，单位s。
end_timeInteger是1665744613终止时间，单位s。
granularityInteger否3600聚合时间粒度，单位s。

返回参数

参数类型示例值描述
dataObject of ReleaseDetailResponseData-版本详情。
error_msgString-错误信息，成功为空。
error_noInteger0错误码，成功为0。

ReleaseDetailResponseData

参数类型示例值描述
trendObject of ReleaseTrendInfo-指定版本的pv，uv，js错误数，js错误聚合issue数，新增js错误数，新增js聚合issue数变化趋势。
jserr_infoObject of ReleaseJSErrorInfo-指定版本js错误信息。
overview_infoObject of ReleaseOverviewInfo-指定版本总览信息。

ReleaseTrendInfo

参数类型示例值描述
pv_uvObject of ChartData-pv/uv 返回两条线，代表pv/uv。
err_countObject of ChartData-错误个数，返回两条线，代表新错误聚合issue数/总错误聚合issue数。
err_timesObject of ChartData-错误次数，返回两条线，代表新错误次数/总错误次数。

ReleaseJSErrorInfo

参数类型示例值描述
newArray of NewJSErrorInfo-新增的js错误列表。
fixedArray of FixedJSErrorInfo-已修复的js错误列表。

ReleaseOverviewInfo

参数类型示例值描述
uvLong10独立访客数。
envStringonline版本发布环境。
versionStringv1.2.3版本号。
created_atLong12345678版本创建时间。
deployed_atLong12345678版本部署时间。
jserr_countLong10js聚合issue数。
jserr_timesLong10js错误数。
finalized_atLong12345678版本结束时间。
new_jserr_countLong10新增js聚合issue数。
new_jserr_timesLong10新增js错误数。

ChartData

参数类型示例值描述
fieldsArray of Field-折线图/饼图维度，len(fields)=len(source[i])。
sourceArray of String[["1668355200","js_error","0","0"]]趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。

NewJSErrorInfo

参数类型示例值描述
nameStringTypeErrorjs错误类型。
messageStringvariable z not definedjs错误信息。
filenameString12345.js报错文件名。
issue_idStringe2ed7046a625307277d8498b2cf0c11fjs错误聚合id。

FixedJSErrorInfo

参数类型示例值描述
nameStringTypeErrorjs错误类型。
messageStringvariable z not definedjs错误信息。
filenameString12345.js报错文件名。
issue_idStringe2ed7046a625307277d8498b2cf0c11fjs错误聚合id。
commit_urlString-关联commit url。
commit_messageString-commit 信息,。

Field

参数类型示例值描述
idStringdate维度key。
nameString日期维度名。
dataTypeStringstring维度类型。
aggregateString-聚合方式。

请求示例

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"
                    ]
                ]
            }
        }
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码。