有奖征文:轻量对象存储LighthouseCOS用户实践> HOT

1. 接口描述

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

创建告警规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePrometheusAlertRule。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例id
示例值:prom-abc
AlertRule PrometheusAlertRuleDetail 告警配置
示例值:参考复杂类型

3. 输出参数

参数名称 类型 描述
Id String 告警id
示例值:alert-def
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增告警

新增告警,并选择使用模板

输入示例

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

{
    "InstanceId": "prom-test",
    "AlertRule": {
        "TemplateId": "temp-test",
        "Name": "test",
        "Rules": [
            {
                "Describe": "pod处于NotReady状态超过15分钟",
                "Name": "KubePodNotReady",
                "For": "",
                "Labels": [
                    {
                        "Name": "severity",
                        "Value": "warning"
                    }
                ],
                "Rule": "sum by (cluster,namespace, pod) (\n  max by(cluster,namespace, pod) (\n    kube_pod_status_phase{job=\"kube-state-metrics\", phase=~\"Pending|Unknown\"}\n  ) * on(cluster,namespace, pod) group_left(owner_kind) topk by(cluster,namespace, pod) (\n    1, max by(cluster,namespace, pod, owner_kind) (kube_pod_owner{owner_kind!=\"Job\"})\n  )\n) > 0\n",
                "Template": "集群 {{ $labels.cluster }}/namespace {{ $labels.namespace }}/Pod {{ $labels.pod }}处于NotReady状态超过15分钟",
                "Annotations": [
                    {
                        "Name": "content",
                        "Value": "pod crash"
                    }
                ]
            }
        ],
        "Notification": {
            "RepeatInterval": "5h",
            "TimeRangeStart": "00:00:00",
            "Enabled": true,
            "PhoneNotifyOrder": [
                1
            ],
            "PhoneInnerInterval": 0,
            "PhoneCircleInterval": 0,
            "NotifyWay": [
                "SMS"
            ],
            "ReceiverGroups": [
                1
            ],
            "PhoneArriveNotice": true,
            "PhoneCircleTimes": 0,
            "Type": "amp",
            "TimeRangeEnd": "23:59:59"
        }
    }
}

输出示例

{
    "Response": {
        "Id": "alert-123",
        "RequestId": "85438a95-6e0d-422e-a099-123456789"
    }
}

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 Param。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.Param 参数错误。
InvalidParameter.PromInstanceNotFound Prometheus实例不存在。
ResourceNotFound 资源不存在。