Docs

Cloud Monitor

Notification policy

ListNotifications

Query the list of notification policies.

Request descriptions

Request method: POST

Request URL: https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListNotifications&Version=2018-01-01

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListNotifications	The name of the API. The API name is ListNotifications.
Version	String	Yes	2018-01-01	The API version. The current API version is 2018-01-01.
Name	String	No	notification-demo	Alert notification policy name based on which filtering is performed.
Levels	Array of String	No	notice	Alert notification levels based on which filtering is performed. Values: notice warning critical recovery
RuleIds	Array of String	No	189898***00	Alert notification policy IDs based on which filtering is performed. You can call the ListNotifications API to query notification policy IDs.
PageNumber	Integer	No	1	Page number of the list. The default value is 1. The list range to be queried is: Actual start position = (PageNumber-1) * PageSize Actual end position = PageNumber * PageSize
PageSize	Integer	No	10	Number of rows per page for a pagination query. The default value is 10. The value must be greater than 0.

Sample request

POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListNotifications&Version=2018-01-01​
Content-Type: application/json​
{​
    "Name": "notification-demo",​
    "Levels": [​
        "notice"​
    ],​
    "RuleIds": [​
        "189898***00"​
    ],​
    "PageNumber": 1,​
    "PageSize": 10​
}​

Response parameters

Parameters	Type	Sample value	Description
Data	Array of Notification	-	Notification policy details.

Notification

Parameters	Type	Sample value	Description
Id	String	189898***00	Notification policy ID.
Name	String	notification-demo	Notification policy name.
Levels	Array of String	notice	Alert notification levels.
RuleIds	Array of String		ID of the associated alert policy.
CreatedAt	String	2021-10-20T20:27:53+08:00	The time when the notification policy was created.
UpdatedAt	String	2021-10-20T20:27:53+08:00	The time when the notification policy was last updated.
EffectEndAt	String	23:59	The time when the notification policy stops being in effect. The time is in the format HH:MM (example: 23:59).
EffectStartAt	String	00:00	The time when the notification policy starts taking effect. The time is in the format HH:MM (example: 00:00).
Notifications	Array of NotificationNotify	-	Details of the notification policy for leveled alerting.

NotificationNotify

Parameters	Type	Sample value	Description
Level	String	critical	Alerting level.
WebhookIds	Array of String	18913208***4528	Webhook callback ID.
AlertMethods	Array of String	Email	Alert notification method.
ContactGroupIds	Array of String	145080093687100****	Alert contact group ID.
NotifyTemplates	Array of NotifyTemplateBasic	-	Notification template configuration.

NotifyTemplateBasic

Parameters	Types	Sample value	Description
Channel	String	email	Notification channel. Values: email: Email sms: SMS phone: Phone call lark: Feishu dingtalk: DingTalk wecom: WeCom slack: Slack api: Callback address
NotifyTemplateId	String	189828***00	Notification template ID. warning Only one notification template ID can be specified for each notification channel.

Sample response

{​
    "ResponseMetadata": {​
        "Action": "ListNotifications",​
        "Region": "cn-beijing",​
        "Service": "cloudmonitor",​
        "Version": "2018-01-01",​
        "RequestId": "20230604110420****100232280022D31"​
    },​
    "Result": {​
        "Data": [​
            {​
                "Id": "189898***00",​
                "Name": "notification-demo",​
                "Levels": [​
                    "notice"​
                ],​
                "CreatedAt": "2021-10-20T20:27:53+08:00",​
                "UpdatedAt": "2021-10-20T20:27:53+08:00",​
                "EffectEndAt": "23:59",​
                "EffectStartAt": "00:00",​
                "Notifications": [​
                    {​
                        "Level": "critical",​
                        "WebhookIds": [​
                            "18913208***4528"​
                        ],​
                        "AlertMethods": [​
                            "Email"​
                        ],​
                        "ContactGroupIds": [​
                            "145080093687100****"​
                        ],​
                        "NotifyTemplates": [​
                            {​
                                "Channel": "email",​
                                "NotifyTemplateId": "189828***00"​
                            }​
                        ]​
                    }​
                ]​
            }​
        ],​
        "PageSize": 30,​
        "PageNumber": 1,​
        "TotalCount": 2​
    }​
}​

Error code

There are no error codes specific to this API. For more information, see Error codes.

Last updated: 2026.07.10 14:02:22