You need to enable JavaScript to run this app.
导航
托管 Prometheus
  • 文档首页
    • /
  • 托管 Prometheus

ListNotifyPolicies

最近更新时间：2024.04.19 11:53:55

首次发布时间：2023.06.30 15:23:34

我的收藏

获取告警通知策略。

请求说明

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

请求参数

参数名称类型是否必选示例值描述
ActionString是ListNotifyPolicies公共参数，本接口值：ListNotifyPolicies。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
PageNumberInteger否1当前页数，最小值或默认值均为 1。

PageSize

Integer

否

10

单页数量：

  • 取值范围为 0～100。
  • 默认值为 10。
FilterObject NotifyPolicyFilter否-告警通知策略过滤条件。

NotifyPolicyFilter

参数名称类型是否必选示例值描述
IdsArray of String否["8cd7b480-6387-44e5-aea4-db4ca2c4b47a"]按告警通知策略 ID 过滤，精确查询。
NameString否test按告警通知策略名称过滤，模糊查询。
ContactGroupIdsArray of String否["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"]按联系人组 ID 过滤，精确查询。

请求示例

POST /?Action=ListNotifyPolicies&Version=2021-03-03
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Ids": ["8cd7b480-6387-44e5-aea4-db4ca2c4b47a"],
        "Name": "test",
        "ContactGroupIds": ["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"]
    }
}

返回参数

参数名称类型示例值描述
TotalInteger100告警通知策略总数。
ItemsArray of NotifyPolicy-告警通知策略列表。

NotifyPolicy

参数名称类型示例值描述
IdString8cd7b480-6387-44e5-aea4-db4ca2c4b47a告警通知策略 ID。
CreateTimeString2020-01-01T00:00:00Z告警通知策略创建时间，RFC3339 格式。
NameStringtest告警通知策略名称。
DescriptionString这是一段描述告警通知策略描述信息。
LevelsArray of NotifyPolicyLevel-告警通知策略等级。

NotifyPolicyLevel

参数名称类型示例值描述
LevelStringP0告警通知策略等级，包括：P0、P1 和 P2。
ContactGroupIdsArray of String["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"]告警联系人组 ID。

Channels

Array of String

["Email"]

告警通知方式：

  • Email：邮件
  • Webhook：通用 Webhook
  • LarkBotWebhook：飞书机器人
  • DingTalkBotWebhook：钉钉机器人

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListNotifyPolicies",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": "8cd7b480-6387-44e5-aea4-db4ca2c4b47a",
                "CreateTime": "2020-01-01T00:00:00Z",
                "Name": " test",
                "Description": "这是一段描述",
                "Levels": [
                    {
                        "Level": "P0",
                        "ContactGroupIds": ["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"],
                        "Channels": ["Email"]
                    }
                ]
            }
        ]
    }
}

错误码

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

HTTP 状态码错误码错误信息描述
400InvalidParameter.{{parameter}}The specified {{parameter}} is invalid.参数不合法，请检查参数正确性后重试。
403ProductUnsubscribedYou 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 服务。