Querying Message Templates
Function
This API is used to query the message template list.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/{domain_id}/lts/events/notification/templates
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 32 Maximum: 32 |
domain_id |
Yes |
String |
Account ID. For details about how to obtain an account ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 32 Maximum: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token. Minimum: 1000 Maximum: 2000 |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. Minimum: 30 Maximum: 30 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
results |
Array of NotificationTemplate objects |
Template array. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Notification rule name, which is mandatory. The value can contain only digits, letters, underscores (), and hyphens (-), and cannot start or end with special characters such as underscores (). The value can contain 1 to 100 characters and cannot be changed after being created. Minimum: 1 Maximum: 100 |
type |
Array of strings |
This field is reserved and optional. |
desc |
String |
Template description, which is optional. Enter a maximum of 1,024 characters, including only digits, letters, and underscores (). Do not start or end with an underscore (). Minimum: 0 Maximum: 1024 |
source |
String |
Template source. Currently, this parameter must be set to LTS. Otherwise, the template cannot be filtered. Minimum: 3 Maximum: 3 |
locale |
String |
Language, which is mandatory. The value can be zh-cn or en-us. |
templates |
Array of SubTemplateResBody objects |
Template body, which is an array. |
create_time |
Long |
Creation time (timestamp in milliseconds). Minimum: 0 Maximum: 1700000000000 |
modify_time |
Long |
Update time (timestamp in milliseconds). Minimum: 0 Maximum: 1700000000000 |
project_id |
String |
Project ID. For details about how to obtain a project ID, see Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID. Minimum: 32 Maximum: 32 |
Parameter |
Type |
Description |
---|---|---|
sub_type |
String |
Template subtype. Only the following types are supported: sms, dingding, wechat, webhook, and email. Value: |
content |
String |
In the subtemplate body, the variables following the dollar sign ($) can only be the following variables. The supported variables vary according to the alarm type (keyword or SQL). Currently, the two alarm types have the following common variables: Severity: ${event_severity}; Occurred: ${starts_at}; Alarm source: $event.metadata.resource_provider; Resource type: $event.metadata.resource_type; Resource ID: ${resources}; Statistical type: by keyword; Expression: $event.annotations.condition_expression; Current value: $event.annotations.current_value; Statistical period: $event.annotations.frequency; Variables specific to keyword alarms: Query time: $event.annotations.results[0].time; Query log: $event.annotations.results[0].raw_results; Variables specific to SQL alarms: Log group/stream name: $event.annotations.results[0].resource_id; Query statement: $event.annotations.results[0].sql; Query time: $event.annotations.results[0].time; Query URL: $event.annotations.results[0].url; Query log: $event.annotations.results[0].raw_results;
NOTE:
Each variable must be followed by an English semicolon (;). Otherwise, the template replacement fails. |
topic |
String |
Email subject. This parameter is valid only when sub_type is set to email. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 8 |
error_msg |
String |
Error message. |
Example Requests
Query the message template list.
GET https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates /v2/{project_id}/{domain_id}/lts/events/notification/templates
Example Responses
Status code: 200
The request is successful.
{ "results" : [ { "create_time" : 1701352010150, "desc" : "This is the SMS test mode.", "locale" : "zh-cn", "modify_time" : 1701352010150, "name" : "15nWzUsOHA", "project_id" : "2a473356cca5487f8373be891bffc1cf", "source" : "LTS", "templates" : [ { "content" : "\"This is an SMS test template.\"", "sub_type" : "sms" } ], "type" : [ "" ] }, { "create_time" : 1702021411612, "desc" : "This is the SMS test mode.", "locale" : "zh-cn", "modify_time" : 1702021411612, "name" : "RZ2ObeluNN", "project_id" : "2a473356cca5487f8373be891bffc1cf", "source" : "LTS", "templates" : [ { "content" : "\"This is an SMS test template.\"", "sub_type" : "sms" } ], "type" : [ "" ] } ] }
Status code: 500
The server has received the request but encountered an internal error.
{ "error_code" : "LTS.2017", "error_msg" : "Find Alarm rule failed." }
Status Codes
Status Code |
Description |
---|---|
200 |
The request is successful. |
500 |
The server has received the request but encountered an internal error. |
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