GetAppGroup

MonitorConfigJson

The alarm notification configuration. The value is a JSON string that supports the following properties: sendChannel, alarmType, and webhookIsAtAll.

Properties

The alarm contact configuration. The format of the value depends on the alarmType specified in MonitorConfigJson.

Value format

• When alarmType is Contacts

  • The value is an array of contact objects. Each object contains the following property:

    • name: The name of the contact.

    • SMS: sms.

    • Email: mail.

    • Phone Call: phone.

• When alarmType is ContactGroup

  • Contacts: Specifies the alarm contacts.

    The value is a single object that contains the following property:

  • ContactGroup: Represents an Alarm Contact Group.

• @ all members (webhookIsAtAll):

  • The value is "true" or "false", indicating whether to @ all group members when a notification is sent.

Examples

{
    "sendChannel": "ding,sms,mail,phone",
    "alarmType": "Contacts",
    "webhookIsAtAll": true
}

MonitorContactsJson details

The configuration for alarm contacts is provided in two formats based on the alarmType.

Configuration format

This field must be in JSON format and supports two configurations: a contact array and a contact group object.

Properties

• Example 1: When alarmType is Contacts

  • An array of contact objects. Each object must contain the following:

    • name: The name of the contact.

• Example 2: When alarmType is ContactGroup

  • A single object that contains:

    • name: The name of the contact group.

Example:

• Example 1 (when alarmType is Contacts):

  [
      {"name": "John"},
      {"name": "Mary"}
  ]
  

• Example 2 (when alarmType is ContactGroup):

  {
      "name": "Alarm Contact Group-1"
  }