ListAlerts--托管 Prometheus-火山引擎

文档中心

立即注册

导航

ListAlerts

最近更新时间：2024.09.03 15:42:18首次发布时间：2023.06.30 15:23:34

获取告警列表。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListAlerts	接口名称。当前 API 的名称为 `ListAlerts`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Limit	Long	否	10	告警单页数量：默认值 10。取值范围 0～100。
SearchAfter	String	否	*********	翻页 Token。
Filter	Object of AlertFilter	否	-	告警过滤条件。
OrderBy	String	否	InitialAlertTimestamp	告警排序键，固定取值为`InitialAlertTimestamp`。
Desc	Boolean	否	true	是否采用降序排序，取值： true：采用降序排序。 false：不采用降序排序。

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 过滤，精确查询。

请求示例

POST https://open.volcengineapi.com/?Action=ListAlerts&Version=2021-03-03
Content-Type: application/json
{
    "Limit": 10,
    "SearchAfter": "\\*\\*\\*\\*\\*\\*\\*\\*\\*",
    "Filter": {
        "Ids": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "Level": "P0",
        "CurrentPhase": "Active",
        "AlertingRuleIds": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ]
    },
    "OrderBy": "InitialAlertTimestamp",
    "Desc": true
}

返回参数

参数	类型	示例值	描述
Total	Long	100	告警总数。
ContinueToken	String	*******	用来分段 List 对象时填入的翻页 Token。
Items	Array of Alert	-	告警列表。

Alert

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	告警事件 ID。
AlertingRuleId	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	告警规则 ID。
Levels	Array of AlertingRuleLevel		告警等级类别。
InitialAlertTimestamp	String	2020-01-01T00:00:00Z	告警开始时间，RFC3339 格式。
LastAlertTimestamp	String	2020-01-01T00:00:00Z	告警最近触发时间，RFC3339 格式。
ResolveTimestamp	String	2020-01-01T00:00:00Z	告警结束时间，RFC3339 格式。
CurrentPhase	String	Active	告警状态： Pending：达到告警阈值但未满告警持续时间 Active：告警中 Resolved：自然解除 Disabled：人工解除
CurrentLevel	String	P0	告警事件等级，包括：P0、P1 和 P2。
AlertingRuleType	String	vmp/PromQL	告警规则类型，固定值为`vmp/PromQL`。
AlertingRuleQuery	Object of AlertingRuleQuery	-	告警配置。
Resource	Object of AlertResource	-	告警资源。

AlertingRuleLevel

参数	类型	示例值	描述
Level	String	P0	警规则等级，包括：P0、P1 和 P2。
For	String	5m	告警持续时间，取值： 0s：立即触发 1m：1分钟 2m：2分钟 5m：5分钟 10m：10分钟
Comparator	String	>	告警规则比较条件，取值： > ：大于 >= ：大于等于 < ：小于 <= ：小于等于 == ：等于 != ：不等于
Threshold	Double	1.0	告警规则阈值。

AlertingRuleQuery

参数	类型	示例值	描述
WorkspaceId	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。
PromQL	String	sum(up)	查询语句。

AlertResource

参数	类型	示例值	描述
Labels	Array of LabelKeyValuePair	-	资源标签列表。列表中每个值以 kv 结构组成。 key 值为资源标签（如 Pod）。 value 为资源名称（如 Pod Name）。

LabelKeyValuePair

参数	类型	示例值	描述
Key	String	key	键
Value	String	value	值

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListAlerts",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 100,
        "ContinueToken": "\\*\\*\\*\\*\\*\\*\\*",
        "Items": [
            {
                "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "Levels": [
                    {
                        "For": "5m",
                        "Level": "P0",
                        "Threshold": 1,
                        "Comparator": ">"
                    }
                ],
                "Resource": {
                    "Labels": [
                        {
                            "Key": "key",
                            "Value": "value"
                        }
                    ]
                },
                "CurrentLevel": "P0",
                "CurrentPhase": "Active",
                "AlertingRuleId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "AlertingRuleType": "vmp/PromQL",
                "ResolveTimestamp": "2020-01-01T00:00:00Z",
                "AlertingRuleQuery": {
                    "PromQL": "sum(up)",
                    "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
                },
                "LastAlertTimestamp": "2020-01-01T00:00:00Z",
                "InitialAlertTimestamp": "2020-01-01T00:00:00Z"
            }
        ]
    }
}

错误码

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

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 服务。