获取版本列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=ReleaseList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | ReleaseList | 接口名称。当前 API 的名称为 ReleaseList。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of CommonParams | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| filter_name | String | 否 | v1. | 版本号模糊搜索。 |
| env | String | 否 | online | 搜索指定环境的版本号，不填为全部环境 |
| page_no | Long | 否 | 1 | 页号。 |
| page_size | Long | 否 | 10 | 每页项数。 |
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。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of ListResponseData | - | 版本列表。 |
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
ListResponseData
ReleaseListInfo
ChartData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| fields | Array of Field | - | 折线图/饼图维度，len(fields)=len(source[i])。 |
| source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。 |
Field
| 参数 | 类型 | 示例值 | 描述 |
|---|
| id | String | date | 维度key。 |
| name | String | 日期 | 维度名。 |
| dataType | String | string | 维度类型。 |
| aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com/?Action=ReleaseList&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
},
"page_size": 10,
"env": "online",
"page_no": 1,
"filter_name": "v1."
}
返回示例
{
"error_no": 0,
"data": {
"data": [
{
"new_jserr_trend": {
"data": {
"fields": [
{
"aggregate": "",
"name": "日期",
"id": "date",
"dataType": "string"
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
}
},
"deployed_at": 12345678,
"version": "v1.2.3",
"jserr_trend": {
"data": {
"fields": [
{
"name": "日期",
"dataType": "string",
"id": "date",
"aggregate": ""
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
}
},
"pv_trend": {
"data": {
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
],
"fields": [
{
"aggregate": "",
"id": "date",
"dataType": "string",
"name": "日期"
}
]
}
},
"env": "online"
}
],
"total": 10
},
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。