ListNotifyPolicies--托管 Prometheus-火山引擎

文档中心

立即注册

导航

ListNotifyPolicies

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

获取告警通知策略。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListNotifyPolicies	接口名称。当前 API 的名称为 `ListNotifyPolicies`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量：取值范围为 0～100。默认值为 10。
Filter	Object of NotifyPolicyFilter	否	-	告警通知策略过滤条件。
SortBy	String	否	CreatedAt	查询结果是否进行排序，取值`CreatedAt`表示进行排序；不配置该字段表示不进行排序。
SortOrder	String	否	Asc	查询结果的排序原则，取值： Asc：表示按照升序排序。 Desc：表示按照降序排序。

NotifyPolicyFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	按告警通知策略 ID 过滤，精确查询。
Name	String	否	test	按告警通知策略名称过滤，模糊查询。
ContactGroupIds	Array of String	否	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	按联系人组 ID 过滤，精确查询。

请求示例

POST https://open.volcengineapi.com/?Action=ListNotifyPolicies&Version=2021-03-03
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Ids": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "Name": "test",
        "ContactGroupIds": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ]
    },
    "SortBy": "CreatedAt",
    "SortOrder": "Asc"
}

返回参数

参数	类型	示例值	描述
Total	Long	100	告警通知策略总数。
Items	Array of NotifyPolicy	-	告警通知策略列表。

NotifyPolicy

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	告警通知策略 ID。
CreateTime	String	2020-01-01T00:00:00Z	告警通知策略创建时间，RFC3339 格式。
Name	String	test	告警通知策略名称。
Description	String	这是一段描述	告警通知策略描述信息。
Levels	Array of NotifyPolicyLevel	-	告警通知策略等级。

NotifyPolicyLevel

参数	类型	示例值	描述
Level	String	P0	告警通知策略等级，包括：P0、P1 和 P2。
ContactGroupIds	Array of String	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	告警通知策略的联系人组。
Channels	Array of String	["Email"]	告警通知策略的告警通知方式： Email：邮件 Webhook：通用 Webhook LarkBotWebhook：飞书机器人 DingTalkBotWebhook：钉钉机器人 WeComBotWebhook：企业微信机器人

参数

类型

示例值

描述

Level

String

告警通知策略等级，包括：P0、P1 和 P2。

ContactGroupIds

Array of String

["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]

告警通知策略的联系人组。

Channels

Array of String

["Email"]

告警通知策略的告警通知方式：

Email：邮件
Webhook：通用 Webhook
LarkBotWebhook：飞书机器人
DingTalkBotWebhook：钉钉机器人
WeComBotWebhook：企业微信机器人

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListNotifyPolicies",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "Name": "test",
                "Levels": [
                    {
                        "Level": "P0",
                        "Channels": [
                            "Email"
                        ],
                        "ContactGroupIds": [
                            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
                        ]
                    }
                ],
                "CreateTime": "2020-01-01T00:00:00Z",
                "Description": "这是一段描述"
            }
        ]
    }
}

错误码

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

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