腾讯云可观测平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 腾讯云可观测平台

新建模板

最近更新时间：2024-03-12 01:40:50

我的收藏

本页目录：

1. 接口描述

接口请求域名： monitor.tencentcloudapi.com 。

创建一个云原生Prometheus模板

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreatePrometheusTemp。
Version 是 String 公共参数，本接口取值：2018-07-24。
Region 是 String 公共参数，详见产品支持的 地域列表。
Template 是 PrometheusTemp 模板设置

3. 输出参数

参数名称 类型 描述
TemplateId String 模板Id
示例值：temp-xxx
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个模板

创建一个模板

输入示例

https://monitor.tencentcloudapi.com/?Action=CreatePrometheusTemp
&Template.Name=t1
&Template.Describe=一个模板
&Template.ServiceMonitors.0.Name=s
&Template.ServiceMonitors.0.Config=abc
&Template.Level=cluster
&<公共请求参数>

{
  "Template": {
    "Name": "abc",
    "Describe": "abc",
    "Level": "abc",
    "RecordRules": [
      {
        "Name": "abc",
        "Config": "abc",
        "TemplateId": "abc",
        "Targets": {
          "Total": 1,
          "Up": 1,
          "Down": 1,
          "Unknown": 1
        }
      }
    ],
    "ServiceMonitors": [
      {
        "Name": "abc",
        "Config": "abc",
        "TemplateId": "abc",
        "Targets": {
          "Total": 1,
          "Up": 1,
          "Down": 1,
          "Unknown": 1
        }
      }
    ],
    "PodMonitors": [
      {
        "Name": "abc",
        "Config": "abc",
        "TemplateId": "abc",
        "Targets": {
          "Total": 1,
          "Up": 1,
          "Down": 1,
          "Unknown": 1
        }
      }
    ],
    "TemplateId": "abc",
    "UpdateTime": "abc",
    "Version": "abc",
    "IsDefault": true,
    "AlertDetailRules": [
      {
        "Id": "abc",
        "Name": "abc",
        "TemplateId": "abc",
        "Notification": {
          "Enabled": true,
          "Type": "abc",
          "WebHook": "abc",
          "AlertManager": {
            "ClusterType": "abc",
            "ClusterId": "abc",
            "Url": "abc"
          },
          "RepeatInterval": "abc",
          "TimeRangeStart": "abc",
          "TimeRangeEnd": "abc",
          "NotifyWay": [
            "abc"
          ],
          "ReceiverGroups": [
            "abc"
          ],
          "PhoneNotifyOrder": [
            1
          ],
          "PhoneCircleTimes": 0,
          "PhoneInnerInterval": 0,
          "PhoneCircleInterval": 0,
          "PhoneArriveNotice": true
        },
        "Rules": [
          {
            "Name": "abc",
            "Rule": "abc",
            "Labels": [
              {
                "Name": "abc",
                "Value": "abc"
              }
            ],
            "Template": "abc",
            "For": "abc",
            "Describe": "abc",
            "Annotations": [
              {
                "Name": "abc",
                "Value": "abc"
              }
            ],
            "RuleState": 0
          }
        ],
        "UpdatedAt": "abc",
        "ClusterId": "abc",
        "Interval": "abc"
      }
    ],
    "TargetsTotal": 0
  }
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "TemplateId": "temp-xxx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InternalError.Param InternalError.Param
InternalError.UnexpectedInternal InternalError.UnexpectedInternal
InvalidParameter.Param InvalidParameter.Param
中国站