{
  "name": "monitor",
  "display_name": "腾讯云可观测平台",
  "description": "介绍如何使用API对腾讯云可观测平台进行操作，包括查询监控数据、创建报警规则等。",
  "domain": "monitor",
  "api_version": "2023-06-16",
  "endpoint": "monitor.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateNoticeContentTmpl",
      "description": "创建自定义通知内容模板",
      "status": "online",
      "parameters": [
        {
          "name": "TmplName",
          "type": "string",
          "required": true,
          "description": "模板名称",
          "example": "自定义内容模板"
        },
        {
          "name": "MonitorType",
          "type": "string",
          "required": true,
          "description": "监控类型",
          "example": "MT_QCE"
        },
        {
          "name": "TmplContents",
          "type": "object",
          "required": true,
          "description": "模板内容",
          "example": "无",
          "children": [
            {
              "name": "QCloudYehe",
              "type": "array",
              "required": false,
              "description": "官网通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "Email",
                      "type": "object",
                      "required": false,
                      "description": "邮件通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "QYWX",
                      "type": "object",
                      "required": false,
                      "description": "企业微信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "SMS",
                      "type": "object",
                      "required": false,
                      "description": "短信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "Voice",
                      "type": "object",
                      "required": false,
                      "description": "语音通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "WeChat",
                      "type": "object",
                      "required": false,
                      "description": "微信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "Site",
                      "type": "object",
                      "required": false,
                      "description": "站内信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "Andon",
                      "type": "object",
                      "required": false,
                      "description": "安灯通知渠道",
                      "example": "无"
                    }
                  ]
                }
              ]
            },
            {
              "name": "WeWorkRobot",
              "type": "array",
              "required": false,
              "description": "企业微信机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "DingDingRobot",
              "type": "array",
              "required": false,
              "description": "钉钉机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    },
                    {
                      "name": "TitleTmpl",
                      "type": "string",
                      "required": false,
                      "description": "标题模板",
                      "example": "标题{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "FeiShuRobot",
              "type": "array",
              "required": false,
              "description": "飞书机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    },
                    {
                      "name": "TitleTmpl",
                      "type": "string",
                      "required": false,
                      "description": "标题模板",
                      "example": "标题{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "Webhook",
              "type": "array",
              "required": false,
              "description": "自定义Webhook通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": false,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": false,
                  "description": "自定义Webhook内容模板",
                  "example": "无",
                  "children": [
                    {
                      "name": "Body",
                      "type": "string",
                      "required": true,
                      "description": "请求体",
                      "example": "e3sibmFtZSI6ICJ7ey5zdGFmZn19In0="
                    },
                    {
                      "name": "BodyContentType",
                      "type": "string",
                      "required": false,
                      "description": "请求体的类型，非必填、默认为JSON 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "application/json"
                    },
                    {
                      "name": "Headers",
                      "type": "array",
                      "required": false,
                      "description": "请求头 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "[{\"Key\": \"k\", \"Values\": [\"v\"]}",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            },
            {
              "name": "TeamsRobot",
              "type": "array",
              "required": false,
              "description": "Teams机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "PagerDutyRobot",
              "type": "array",
              "required": false,
              "description": "PagerDutyRobot机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": false,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": false,
                  "description": "自定义PagerDutyRobot内容模板",
                  "example": "无",
                  "children": [
                    {
                      "name": "Body",
                      "type": "string",
                      "required": false,
                      "description": "请求体模板 仅支持json",
                      "example": "e3sibmFtZSI6ICJ7ey5zdGFmZn19In0="
                    },
                    {
                      "name": "Headers",
                      "type": "array",
                      "required": false,
                      "description": "请求头 暂时未支持 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "TitleTmpl",
                      "type": "string",
                      "required": false,
                      "description": "标题模板",
                      "example": "标题"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "TmplLanguage",
          "type": "string",
          "required": true,
          "description": "模板语言 en/zh",
          "example": "zh"
        }
      ],
      "required": [
        "TmplName",
        "MonitorType",
        "TmplContents",
        "TmplLanguage"
      ]
    },
    {
      "name": "DeleteNoticeContentTmpls",
      "description": "删除通知内容模板",
      "status": "online",
      "parameters": [
        {
          "name": "TmplIDs",
          "type": "array",
          "required": false,
          "description": "要删除的模板id",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAlarmNotifyHistories",
      "description": "按需查询告警的通知历史",
      "status": "online",
      "parameters": [
        {
          "name": "MonitorType",
          "type": "string",
          "required": true,
          "description": "监控类型",
          "example": "MT_PROME"
        },
        {
          "name": "QueryBaseTime",
          "type": "integer",
          "required": true,
          "description": "起始时间点，unix秒级时间戳",
          "example": "1732801290"
        },
        {
          "name": "QueryBeforeSeconds",
          "type": "integer",
          "required": true,
          "description": "从 QueryBaseTime 开始，需要查询往前多久的时间，单位秒",
          "example": "1800"
        },
        {
          "name": "PageParams",
          "type": "object",
          "required": true,
          "description": "分页参数",
          "example": "{1,2}",
          "children": [
            {
              "name": "PerPage",
              "type": "integer",
              "required": false,
              "description": "每个分页的数量是多少 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "19"
            },
            {
              "name": "PageNo",
              "type": "string",
              "required": false,
              "description": "第几个分页，从1开始 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            }
          ]
        },
        {
          "name": "Namespace",
          "type": "string",
          "required": false,
          "description": "当监控类型为 MT_QCE 时候需要填写，归属的命名空间",
          "example": "qce/cvm"
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": false,
          "description": "当监控类型为 MT_QCE 时候需要填写， 告警策略类型",
          "example": "cvm_device"
        },
        {
          "name": "PolicyId",
          "type": "string",
          "required": false,
          "description": "查询某个策略的通知历史",
          "example": "policy-123"
        }
      ],
      "required": [
        "MonitorType",
        "QueryBaseTime",
        "QueryBeforeSeconds",
        "PageParams"
      ]
    },
    {
      "name": "DescribeNoticeContentTmpl",
      "description": "根据查询条件获取自定义通知内容模板，若所有查询条件空，则获取账号下所有模板",
      "status": "online",
      "parameters": [
        {
          "name": "PageNumber",
          "type": "integer",
          "required": true,
          "description": "分页数",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "分页大小",
          "example": "10"
        },
        {
          "name": "TmplIDs",
          "type": "array",
          "required": false,
          "description": "指定模板ID查询，查询参数都为空则默认查询账号下所有模板",
          "example": "[\"tmpl-1\"]",
          "item_type": "string"
        },
        {
          "name": "TmplName",
          "type": "string",
          "required": false,
          "description": "指定模板名称查询，查询参数都为空则默认查询账号下所有模板",
          "example": "自定义模板"
        },
        {
          "name": "NoticeID",
          "type": "string",
          "required": false,
          "description": "指定通知模板ID查询，查询参数都为空则默认查询账号下所有模板",
          "example": "notice-xxx"
        },
        {
          "name": "TmplLanguage",
          "type": "string",
          "required": false,
          "description": "模板语言 en/zh 缺省不过滤",
          "example": "zh"
        },
        {
          "name": "MonitorType",
          "type": "string",
          "required": false,
          "description": "监控类型",
          "example": "MT_QCE"
        }
      ],
      "required": [
        "PageNumber",
        "PageSize"
      ]
    },
    {
      "name": "ModifyNoticeContentTmpl",
      "description": "修改通知内容模板",
      "status": "online",
      "parameters": [
        {
          "name": "TmplName",
          "type": "string",
          "required": true,
          "description": "模板名称",
          "example": "自定义内容模板"
        },
        {
          "name": "TmplContents",
          "type": "object",
          "required": true,
          "description": "模板内容",
          "example": "无",
          "children": [
            {
              "name": "QCloudYehe",
              "type": "array",
              "required": false,
              "description": "官网通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "Email",
                      "type": "object",
                      "required": false,
                      "description": "邮件通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "QYWX",
                      "type": "object",
                      "required": false,
                      "description": "企业微信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "SMS",
                      "type": "object",
                      "required": false,
                      "description": "短信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "Voice",
                      "type": "object",
                      "required": false,
                      "description": "语音通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "WeChat",
                      "type": "object",
                      "required": false,
                      "description": "微信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "Site",
                      "type": "object",
                      "required": false,
                      "description": "站内信通知渠道",
                      "example": "无"
                    },
                    {
                      "name": "Andon",
                      "type": "object",
                      "required": false,
                      "description": "安灯通知渠道",
                      "example": "无"
                    }
                  ]
                }
              ]
            },
            {
              "name": "WeWorkRobot",
              "type": "array",
              "required": false,
              "description": "企业微信机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "DingDingRobot",
              "type": "array",
              "required": false,
              "description": "钉钉机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    },
                    {
                      "name": "TitleTmpl",
                      "type": "string",
                      "required": false,
                      "description": "标题模板",
                      "example": "标题{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "FeiShuRobot",
              "type": "array",
              "required": false,
              "description": "飞书机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    },
                    {
                      "name": "TitleTmpl",
                      "type": "string",
                      "required": false,
                      "description": "标题模板",
                      "example": "标题{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "Webhook",
              "type": "array",
              "required": false,
              "description": "自定义Webhook通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": false,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": false,
                  "description": "自定义Webhook内容模板",
                  "example": "无",
                  "children": [
                    {
                      "name": "Body",
                      "type": "string",
                      "required": true,
                      "description": "请求体",
                      "example": "e3sibmFtZSI6ICJ7ey5zdGFmZn19In0="
                    },
                    {
                      "name": "BodyContentType",
                      "type": "string",
                      "required": false,
                      "description": "请求体的类型，非必填、默认为JSON 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "application/json"
                    },
                    {
                      "name": "Headers",
                      "type": "array",
                      "required": false,
                      "description": "请求头 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "[{\"Key\": \"k\", \"Values\": [\"v\"]}",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            },
            {
              "name": "TeamsRobot",
              "type": "array",
              "required": false,
              "description": "Teams机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": true,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": true,
                  "description": "模板配置",
                  "example": "无",
                  "children": [
                    {
                      "name": "ContentTmpl",
                      "type": "string",
                      "required": true,
                      "description": "内容模板",
                      "example": "告警通知模板{{.PolicyName}}"
                    }
                  ]
                }
              ]
            },
            {
              "name": "PagerDutyRobot",
              "type": "array",
              "required": false,
              "description": "PagerDutyRobot机器人通知渠道配置 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "MatchingStatus",
                  "type": "array",
                  "required": false,
                  "description": "匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复",
                  "example": "Trigger",
                  "item_type": "string"
                },
                {
                  "name": "Template",
                  "type": "object",
                  "required": false,
                  "description": "自定义PagerDutyRobot内容模板",
                  "example": "无",
                  "children": [
                    {
                      "name": "Body",
                      "type": "string",
                      "required": false,
                      "description": "请求体模板 仅支持json",
                      "example": "e3sibmFtZSI6ICJ7ey5zdGFmZn19In0="
                    },
                    {
                      "name": "Headers",
                      "type": "array",
                      "required": false,
                      "description": "请求头 暂时未支持 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "无",
                      "item_type": "string"
                    },
                    {
                      "name": "TitleTmpl",
                      "type": "string",
                      "required": false,
                      "description": "标题模板",
                      "example": "标题"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "TmplID",
          "type": "string",
          "required": true,
          "description": "需要修改的模板ID",
          "example": "ntpl-1"
        }
      ],
      "required": [
        "TmplName",
        "TmplContents",
        "TmplID"
      ]
    }
  ]
}