文档中心>API 中心

拉取模板列表

最近更新时间:2024-07-23 01:50:24

我的收藏

1. 接口描述

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

拉取模板列表,默认模板将总是在最前面

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePrometheusTemp。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 仅支持按Name, Values字段过滤:
* Name = Name
按照给定的模板名称列表匹配
* Name = ID
按照给定的模板ID列表匹配
* Name = Describe
按照给定的模板描述列表匹配
* Name = Level
按照给定的模板维度(instance, cluster)列表匹配
示例值: [{"Name": "Name","Values": ["test"]}]
Offset Integer 分页偏移量,默认为0
示例值:0
Limit Integer 分页返回数量,默认为20,最大值为100
示例值:10

3. 输出参数

参数名称 类型 描述
Templates Array of PrometheusTemp 模板列表
示例值:[{"Name":"abc","Describe":"abc","Level":"abc","RecordRules":[{"Name":"abc","Config":"abc","TemplateId":"abc","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":"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}]
Total Integer 总数
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 拉取模板列表

拉取模板列表

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusTemp
<公共请求参数>

{
    "Limit": 1,
    "Filters": [
        {
            "Name": "ID",
            "Values": [
                "alert-test"
            ]
        }
    ],
    "Offset": 1
}

输出示例

{
    "Response": {
        "Templates": [
            {
                "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"
                    }
                ],
                "TargetsTotal": 0
            }
        ],
        "Total": 1,
        "RequestId": "skdh-afbri"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ComponentClientUnpack FailedOperation.ComponentClientUnpack
FailedOperation.DoTRPCTransferFailed DoTRPCTransferFailed
InternalError.Db InternalError.Db
InternalError.Param InternalError.Param
InternalError.UnexpectedInternal InternalError.UnexpectedInternal
InvalidParameter.Param InvalidParameter.Param