Search Mail Template¶
查询邮件模板,范围包括当前 OU 和 system OU。
请求格式¶
GET https://{apigw-address}/notification-center-service/v2.0/email/templates
请求参数 (URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 组织 ID。如何获取 orgId 信息 >> |
pageNo | Query | 可选 | Integer | 分页查询时指定页码,从 1 开始。 |
pageSize | Query | 可选 | Integer | 分页查询时单页返回记录的条数,如未指定,默认每页 10 条。每页最大记录数为 1,000 条,但为获得最佳性能,建议每页不超过 50 条。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | Items 结构体数组和 pagination 结构体数组 |
|
Items 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
orgId | String | 邮件模板所属的 OU ID。 |
templateName | String | 邮件模板名称。 |
templateCode | String | 邮件模板标识符。 |
content | String | 邮件模板内容。 |
parameters | Array | 邮件模板内容中使用的变量列表。 |
subject | String | 邮件模板标题。 |
示例¶
请求示例¶
url: https://{apigw-address}/notification-center-service/v2.0/email/templates?action=get&orgId=yourOrgId&pageNo=2&pageSize=10
method: GET
返回示例¶
{
"code":"0",
"msg":"OK",
"submsg":"",
"data":{
"items":[
{
"orgId":"yourorgId",
"templateName":"alarm-notification-1",
"templateCode":"alarm-notification-1",
"content":"$(INSTANCE) at $(START_TIME) has occurred $(DETAIL), please process ASAP.",
"parameters":[
"INSTANCE",
"START_TIME",
"DETAIL"
],
"subject":"Alarm Notification"
},
{
"orgId":"yourorgId",
"templateName":"alarm-notification-2",
"templateCode":"alarm-notification-2",
"content":"$(EVENT) occurred at $(TIME).
$(DETAIL)
Please verify it ASAP.",
"parameters":[
"EVENT",
"TIME",
"DETAIL"
],
"subject":"Alarm Notification"
},
{
"orgId":"yourorgId",
"templateName":"status-notification",
"templateCode":"status-notification",
"content":"$(SUMMARY)-$(START_TIME) Status: $(STATUS) $(DETAIL)",
"parameters":[
"SUMMARY",
"START_TIME",
"STATUS",
"DETAIL"
],
"subject":"Status Notification"
}
],
"pagination":{
"pageNo":"2",
"pageSize":"10",
"totalSize":"3"
}
},
"requestId":""
}