Help Center/Application Operations Management/API Reference/APIs/Alarm/Querying the Message Template List
Updated on 2025-09-04 GMT+08:00
View PDF

Querying the Message Template List

Function

This API is used to query the message template list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/events/notification/templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM. For details, see Obtaining a Token.

Content-Type

Yes

String

Message body type or format. Content type, which is application/json.

Enterprise-Project-Id

No

String

Enterprise project ID. For details, see Obtaining an Enterprise Project ID.

  • To query the message template of an enterprise project, enter the enterprise project ID.

  • To query the message templates of all enterprise projects, enter all_granted_eps.

  • If this parameter is not specified, the message template of the default enterprise project is returned.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of NotificationTemplate objects

Message template list.

Table 4 NotificationTemplate

Parameter

Type

Description

create_time

Long

Time when a message template was created.

desc

String

Message template description.

enterprise_project_id

String

ID of the enterprise project to which the message template belongs.

locale

String

Message template language.

modify_time

Long

Time when a message template was modified.

name

String

Message template name.

project_id

String

ID of the project to which the message template belongs.

source

String

Message template source.

templates

String

Message template content.

The content is escaped from JSON arrays consisting of the following parameters:

NameMandatoryParameter TypeDescription
contentYesStringMessage template content.
subTypeYesStringNotification mode. Options: email, SMS, and webhook.
topicNoStringEmail subject.
sendTypeNoStringMessage template format, which must be specified if subType is set to webhook. Options: HTML and JSON.
versionYesStringThe default value is v2.

type

Array of strings

Message notification mode.

Example Requests

Query the message template list.

https://{Endpoint}/v2/{project_id}/events/notification/templates

Example Responses

Status code: 200

OK: The request is successful.

[ {
  "create_time" : 1685445932076,
  "desc" : "",
  "enterprise_project_id" : "0",
  "locale" : "zh-cn",
  "modify_time" : 1707011425355,
  "name" : "530en",
  "project_id" : "2a4****6cca****f837****91bf****f",
  "templates" : "[{\"subType\":\"email\",\"version\":\"v2\",\"topic\":\"${region_name}[${event_severity}_${event_type}_${clear_type}] have a new alert at ${starts_at}.\",\"content\":\"\\nAlarm Name:${event_name_alias};\\nAlarm ID:${id};\\nOccurred:${starts_at};\\nEvent Severity:${event_severity};\\nAlarm Info:${alarm_info};\\nResource Identifier:${resources_new};\\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"sms\",\"version\":\"v2\",\"content\":\"\\nAlarm Name:${event_name_alias};\\nAlarm ID:${id};\\nOccurred:${starts_at};\\nEvent Severity:${event_severity};\\nAlarm Info:${alarm_info};\\nResource Identifier:${resources_new};\\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"wechat\",\"version\":\"v2\",\"content\":\"> **Alarm Name:** ${event_name_alias}  \\n> **Alarm ID:** ${id}  \\n> **Occurred:** ${starts_at}  \\n> **Event Severity:** ${event_severity}  \\n> **Alarm Info:** ${alarm_info}  \\n> **Resource Identifier:** ${resources_new}  \\n> **Suggestion:** ${alarm_fix_suggestion_zh}\"},{\"subType\":\"dingding\",\"version\":\"v2\",\"content\":\"> **Alarm Name:** ${event_name_alias}  \\n\\n> **Alarm ID:** ${id}  \\n\\n> **Occurred:** ${starts_at}  \\n\\n> **Event Severity:** ${event_severity}  \\n\\n> **Alarm Info:** ${alarm_info}  \\n\\n> **Resource Identifier:** ${resources_new}  \\n\\n> **Suggestion:** ${alarm_fix_suggestion_zh}\",\"sendType\":\"HTML\"},{\"subType\":\"webhook\",\"version\":\"v2\",\"content\":\"Notification Type:${event_type};\\nSeverity:${event_severity};\\nName:$event.metadata.event_name_alias;\\nOccurred:${starts_at};\\nSource:$event.metadata.resource_provider;\\nResource Type:$event.metadata.resource_type;\\nResource Identifier:${resources_new};\\nPossible Cause:${alarm_probableCause_zh};\\nAdditional Info:${message};\\nSuggestion:${alarm_fix_suggestion_zh};\",\"sendType\":\"HTML\"},{\"subType\":\"voice\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"Notification Type:${event_type};  \\nSeverity:${event_severity};  \\nName:$event.metadata.event_name_alias;  \\nOccurred:${starts_at};  \\nSource:$event.metadata.resource_provider;  \\nResource Type:$event.metadata.resource_type;  \\nResource Identifier:${resources_new};  \\nPossible Cause:${alarm_probableCause_zh};  \\nAdditional Info:${message};  \\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"espace\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"Notification Type:${event_type};  \\nSeverity:${event_severity};  \\nName:$event.metadata.event_name_alias;  \\nOccurred:${starts_at};  \\nSource:$event.metadata.resource_provider;  \\nResource Type:$event.metadata.resource_type;  \\nResource Identifier:${resources_new};  \\nPossible Cause:${alarm_probableCause_zh};  \\nAdditional Info:${message};  \\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"feishu\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"**Alarm Name:** ${event_name_alias}  \\n\\n**Alarm ID:** ${id}  \\n\\n**Occurred:** ${starts_at}  \\n\\n**Event Severity:** ${event_severity}  \\n\\n**Alarm Info:** ${alarm_info}  \\n\\n**Resource Identifier:** ${resources_new}  \\n\\n**Suggestion:** ${alarm_fix_suggestion_zh}\"},{\"subType\":\"welink\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"\\nAlarm Name:${event_name_alias};\\nAlarm ID:${id};\\nOccurred:${starts_at};\\nEvent Severity:${event_severity};\\nAlarm Info:${alarm_info};\\nResource Identifier:${resources_new};\\nSuggestion:${alarm_fix_suggestion_zh};\"}]",
  "type" : [ ]
} ]

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic:Alarm