ListSendAlert--云监控-火山引擎

文档中心

立即注册

导航

ListSendAlert

最近更新时间：2025.06.04 16:21:46首次发布时间：2022.10.27 19:53:20

查询告警通知的历史发送列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListSendAlert&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListSendAlert	接口名称。当前 API 的名称为 `ListSendAlert`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
AlertGroupId	String	否	633508858e241506ac******	告警历史列表 ID。可以调用 ListAlertGroup 接口，获取告警历史列表 ID。
PageNumber	Integer	否	1	列表的页码，取值 > 0，默认值为1。要查询的列表范围为：实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
PageSize	Integer	否	10	分页查询时每页的行数，默认值为 10。

请求示例

POST https://open.volcengineapi.com?Action=ListSendAlert&Version=2018-01-01
Content-Type: application/json
{
    "AlertGroupId": "633508858e241506ac******",
    "PageNumber": 1,
    "PageSize": 10
}

返回参数

参数	类型	示例值	描述
Data	Array of SendAlertVO	-	返回数据。
TotalCount	Integer	2	时间段内的告警记录总数。

SendAlertVO

参数	类型	示例值	描述
Id	String	63340e8f4f5b3bdee9b*****	历史告警 ID。
SendAt	String	2022-09-28T09:06:23.65Z	历史告警发送时间。
SendResult	Array of SendResult	-	历史告警的内容。

SendResult

参数	类型	示例值	描述
ErrMsg	String		错误消息。如果为空，表示没有错误。
Success	Boolean	true	告警消息发送结果。 true：发送成功 false：发送失败
Receiver	String	63329d689e5b169425******	告警发送记录 ID。例如：当告警方式为邮件时，此参数为告警接收者的邮箱。
AlertMethod	String	API	告警发送的通知方式。 Email：邮件 Phone：电话 SMS：短信 API：告警回调

返回示例

{
    "ResponseMetadata": {
        "Action": "ListSendAlert",
        "Region": "cn-beijing",
        "Service": "volc_observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            {
                "Id": "63340e8f4f5b3bdee9b*****",
                "SendAt": "2022-09-28T09:06:23.65Z",
                "SendResult": [
                    {
                        "ErrMsg": "",
                        "Success": true,
                        "Receiver": "63329d689e5b169425******",
                        "AlertMethod": "API"
                    },
                    {
                        "ErrMsg": "",
                        "Success": true,
                        "Receiver": "abc@example.com",
                        "AlertMethod": "Email"
                    },
                    {
                        "ErrMsg": "",
                        "Success": true,
                        "Receiver": "1503875****",
                        "AlertMethod": "SMS"
                    }
                ]
            }
        ],
        "PageSize": 30,
        "PageNumber": 1,
        "TotalCount": 2
    }
}

错误码

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