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": "test",
"Describe": "test",
"Level": "instance",
"RecordRules": [
{
"Name": "testRule",
"Config": "abc",
"TemplateId": "temp-asdj",
"Targets": {
"Total": 1,
"Up": 1,
"Down": 1,
"Unknown": 1
}
}
],
"RawJobs": [
{
"Name": "abc",
"Config": "abc",
"TemplateId": "abc",
"Targets": {
"Total": 1,
"Up": 1,
"Down": 1,
"Unknown": 1
}
}
],
"ServiceMonitors": [
{
"Name": "test-sm",
"Config": "abc",
"TemplateId": "temp-asdj",
"Targets": {
"Total": 1,
"Up": 1,
"Down": 1,
"Unknown": 1
}
}
],
"PodMonitors": [
{
"Name": "test-pm",
"Config": "abc",
"TemplateId": "temp-asdj",
"Targets": {
"Total": 1,
"Up": 1,
"Down": 1,
"Unknown": 1
}
}
],
"TemplateId": "temp-asdj",
"UpdateTime": "2024-07-16T08:28:54Z",
"Version": "v1",
"IsDefault": true,
"AlertDetailRules": [
{
"Id": "rule-asdk",
"Name": "testAlert",
"TemplateId": "temp-asdj",
"Notification": {
"Enabled": true,
"Type": "amp",
"WebHook": "abc",
"AlertManager": {
"ClusterType": "tke",
"ClusterId": "cls-askj",
"Url": "http://asasdkfh:9000"
},
"RepeatInterval": "5m",
"TimeRangeStart": "00:00:00",
"TimeRangeEnd": "23:59:59",
"NotifyWay": [
"abc"
],
"ReceiverGroups": [
"notice-yakj"
],
"PhoneNotifyOrder": [
1
],
"PhoneCircleTimes": 0,
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"PhoneArriveNotice": true
},
"Rules": [
{
"Name": "rule-ajdb",
"Rule": "avg by (abc) skdj",
"Labels": [
{
"Name": "label-name",
"Value": "label-value"
}
],
"Template": "temp-asdj",
"For": "5m",
"Describe": "test-temp",
"Annotations": [
{
"Name": "label-name",
"Value": "label-value"
}
],
"RuleState": 0
}
],
"UpdatedAt": "2024-07-16 16:28:54",
"ClusterId": "cls-djfb",
"Interval": "5m"
}
],
"TargetsTotal": 0
}
}
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"TemplateId": "temp-lejrh"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.Param | InternalError.Param |
InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
InvalidParameter.Param | InvalidParameter.Param |