ListSendAlert--云监控-火山引擎

文档中心

导航

ListSendAlert

最近更新时间：2024.11.15 15:29:40首次发布时间：2022.10.27 19:53:20

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

请求说明

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

ServiceName: Volc_Observe
Region: cn-beijing 
AccessKey: xxx
SecretKey: xxx

调试

API Explorer

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

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListSendAlert`	接口名称。当前 API 的名称为 `ListSendAlert`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数类型是否必选示例值描述

AlertGroupId String 否 633508858e241506ac****** 告警历史ID。调用ListAlertGroup接口查看返回参数里Id的参数取值。

参数	类型	是否必选	示例值	描述
AlertGroupId	String	否	`633508858e241506ac******`	告警历史ID。调用ListAlertGroup接口查看返回参数里`Id`的参数取值。
PageNumber	Integer	否	`1`	列表的页码，取值 > 0，默认值为1。要查询的列表范围为：实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
PageSize	Integer	否	`10`	分页查询时每页的行数，默认值为10。

PageNumber

Integer

否

1

列表的页码，取值 > 0，默认值为1。要查询的列表范围为：

实际起始位置 = (PageNumber-1) * PageSize
实际终止位置 = PageNumber * PageSize

PageSize Integer 否 10 分页查询时每页的行数，默认值为10。

返回参数

参数	类型	示例值	描述
Data	Array of SendAlertVO	`-`	返回数据。
PageSize	Integer	`30`	分页查询参数，用于设置每页行数。默认值：30。
PageNumber	Integer	`1`	分页查询参数，用于设置当前页码。默认值：1。
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：告警回调

请求示例

POST https://open.volcengineapi.com?Action=ListSendAlert&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "Namespace":"VCM_Kafka",
    "AlertGroupId":"6332a1ed9e5b169425******",
    "PageNumber":1,
    "PageSize":30,
    "Filter":""
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20230****44C52",
        "Action":"ListSendAlert",
        "Version":"2018-01-01",
        "Service":"Volc_Observe",
        "Region":"cn-beijing"
    },
    "Result":{
        "Data":[
            {
                "Id":"63340e8f4f5b3bdee9b*****",
                "SendAt":"2022-09-28T09:06:23.65Z",
                "SendResult":[
                    {
                        "Receiver":"abc@11.com",
                        "AlertMethod":"Email",
                        "Success":true,
                        "ErrMsg":""
                    },
                    {
                        "Receiver":"1503875****",
                        "AlertMethod":"SMS",
                        "Success":true,
                        "ErrMsg":""
                    }
                ]
            },
            {
                "Id":"633508998e241506acc*****",
                "SendAt":"2022-09-29T02:53:13.9Z",
                "SendResult":[
                    {
                        "Receiver":"https://open.cn/open-apis/bot/v2/hook/1356***302d3e5e",
                        "AlertMethod":"API",
                        "Success":false,
                        "ErrMsg":""
                    }
                ]
            }
        ],
        "PageNumber":1,
        "PageSize":30,
        "TotalCount":2
    }
}

云监控