GetAlertAnalysis--托管 Prometheus-火山引擎

文档中心

立即注册

导航

GetAlertAnalysis

最近更新时间：2024.09.04 20:04:28首次发布时间：2024.08.16 17:03:02

获取告警统计信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=GetAlertAnalysis&Version=2021-03-03

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetAlertAnalysis	接口名称。当前 API 的名称为 `GetAlertAnalysis`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Filter	Object of AlertFilter	否	-	告警过滤条件。
GroupBy	Array of AlertGroupBy	否	-	告警聚合条件。
AlertSince	Long	否	1600885800	Unix 时间戳,告警开始时间最小值。
AlertUntil	Long	否	1600885800	Unix 时间戳,告警开始时间最大值。
Limit	Long	否	100	告警聚合序列样本个数限制，默认值 100，最大值 500。

AlertFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	按告警 ID 过滤，精确查询。
CurrentPhase	String	否	Active	按告警当前所处状态过滤，精确查询： Pending：达到告警阈值但未满告警持续时间 Active：告警中 Resolved：自然解除 Disabled：人工解除
Level	String	否	P0	告警等级过滤，精确查询。包括：P0、P1 和 P2。
AlertingRuleIds	Array of String	否	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	按告警规则 ID 过滤，精确查询。

AlertGroupBy

参数	类型	是否必选	示例值	描述
GroupBy	String	是	ResourceKey	变量类型，取值： ResourceKey：表示告警根据告警资源聚合。 Level：表示告警根据等级聚合。
ResourceKey	String	否	cluster	ResourceKey 资源。

参数

类型

是否必选

示例值

描述

GroupBy

String

是

ResourceKey

变量类型，取值：

ResourceKey：表示告警根据告警资源聚合。
Level：表示告警根据等级聚合。

ResourceKey

String

否

cluster

ResourceKey 资源。

请求示例

POST https://open.volcengineapi.com/?Action=GetAlertAnalysis&Version=2021-03-03
Content-Type: application/json
{
    "Filter": {
        "Ids": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "Level": "P0",
        "CurrentPhase": "Active",
        "AlertingRuleIds": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ]
    },
    "GroupBy": [
        {
            "GroupBy": "ResourceKey",
            "ResourceKey": "cluster"
        }
    ],
    "AlertSince": 1600885800,
    "AlertUntil": 1600885800,
    "Limit": 100
}

返回参数

参数	类型	示例值	描述
Groups	Array of AlertGroup	-	告警聚合组。

AlertGroup

参数	类型	示例值	描述
Count	Array of Long	100	告警数量。
Timestamps	Array of Long	318	时间戳。
GroupValues	Array of String	p0	聚合类型对应的值。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetAlertAnalysis",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Groups": [
            {
                "Count": [
                    100
                ],
                "Timestamps": [
                    318
                ],
                "GroupValues": [
                    "p0"
                ]
            }
        ]
    }
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
403	ProductUnsubscribed	You are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。