跳转到主要内容
API Explorer|API Explorer
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/报警文本模板（Text Template）
POSTText Template Operations起始版本 2.3同步需要认证

创建报警消息模板

创建报警消息模板

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • applicationPlatformTypeString必填

      SNS应用平台类型

    • templateString必填

      报警消息模板文本

    • recoveryTemplateString必填

      恢复报警模板文本

    • defaultTemplateBoolean

      是否作为默认模板

    • resourceUuidString

      可选。

    • typeString

      可选。

    • tagUuidsList

      标签UUID列表

    • subjectString

      主题

    • recoverySubjectString必填

      恢复主题

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventorySNSTextTemplateInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • applicationPlatformTypeString必填

      应用平台类型

    • templateString必填

      模板文本

    • defaultTemplateBoolean必填

      是否为默认模板

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/zwatch/alarms/sns/text-templates

/zstack/v1/zwatch/alarms/sns/text-templates

操作 ID

CreateSNSTextTemplate

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/zwatch/alarms/sns/text-templates' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","applicationPlatformType":"<applicationPlatformType>","template":"<template>","recoveryTemplate":"<recoveryTemplate>","defaultTemplate":true,"resourceUuid":"<resourceUuid>","type":"<type>","tagUuids":["<tagUuids>"],"subject":"<subject>","recoverySubject":"<recoverySubject>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "533c0a77d8694f068ea0425f587c9c2a", "name": "email template", "applicationPlatformType": "Email", "subject": "Alarm ${ALARM_NAME} [${ALARM_METRIC} ${ALARM_COMPARISON_OPERATOR} threshold ${ALARM_THRESHOLD}] changes status to ${ALARM_CURRENT_STATUS}", "recoverySubject": "Alarm ${ALARM_NAME} ${TITLE_ALARM_RESOURCE_NAME} changes status to ${ALARM_CURRENT_STATUS}", "template": "Alarm ${ALARM_NAME} changes status to ${ALARM_CURRENT_STATUS}", "recoveryTemplate": "Resource ${EVENT_RESOURCE_ID} changes status to ${ALARM_CURRENT_STATUS}", "defaultTemplate": false, "createDate": "Jun 13, 2024 5:26:38 PM", "lastOpDate": "Jun 13, 2024 5:26:38 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史