You need to enable JavaScript to run this app.
导航
MiniProAlarmTrend
最近更新时间:2024.06.18 17:13:43首次发布时间:2024.04.03 17:37:05

调用MiniProAlarmTrend查看报警数量趋势图(报警情况概览)。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=MiniProAlarmTrend&Version=2024-03-12

请求参数

ServiceName : apmplus_openapi 
Region : cn-beijing 
X-App-Ids : xxx 
Content-Type : application/json

Query

参数类型是否必选示例值描述
ActionStringMiniProAlarmTrend接口名称。当前 API 的名称为 MiniProAlarmTrend
VersionString2024-03-12接口版本。当前 API 的版本为 2024-03-12

Body

参数类型是否必选示例值描述
commonObject of Common-通用参数。
time_filterObject of Time_filter-时间区间。
idLong302报警任务ID。

Common

参数类型是否必选示例值描述
aidLong12345应用ID。
osStringminipro服务类型。取值支持app、webpro、minipro。

Time_filter

参数类型是否必选示例值描述
start_timeInteger1665849600起始时间。
granularityInteger60聚合时间粒度。
end_timeInteger1666011403终止时间。

返回参数

参数类型示例值描述
dataObject of Data-返回内容。
error_msgString-错误信息。
error_noInteger0错误码。0为成功。

Data

参数类型示例值描述
alarm_trendObject of Alarm_trend-报警趋势。

Alarm_trend

参数类型示例值描述
fieldsArray of Fields-指标字段。
sourceArray of String[ "2022-10-11 08:00:00", "0" ]与field值对应的值。

Fields

参数类型示例值描述
idStringdate报警时间,为source[i][0]值的含义。
dataTypeStringstring数据类型。
nameStringdate字段名称。

请求示例

POST https://open.volcengineapi.com?Action=MiniProAlarmTrend&Version=2024-03-12
{
    "common": {
        "aid": 12345,
        "os": "minipro"
    },
    "id": 302,
    "time_filter": {
        "start_time": 1665849600,
        "end_time": 1666011403,
        "granularity": 3600
    }
}

返回示例

{
    "err_detail":"",
    "data":{
        "alarm_trend":{
            "fields":[
                {
                    "id":"date",
                    "dataType":"string",
                    "name":"date"
                },
                {
                    "id":"alarm_count",
                    "dataType":"number",
                    "name":"报警总数"
                }
            ],
            "source":[
                [
                    "2022-10-11 08:00:00",
                    "0"
                ],
                [
                    "2022-10-17 08:00:00",
                    "156"
                ]
            ]
        }
    },
    "error_msg":"",
    "error_no":0
}

错误码

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