Querying the Message Template List
Function
This API is used to query the message template list.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
aom:notificationTemplate:list
List
-
-
-
-
URI
GET /v2/{project_id}/events/notification/templates
|
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
|
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.
|
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
[items] |
Array of NotificationTemplate objects |
Message template list. |
|
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:
|
||||||||||||||||||||||||
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot