用户指南

最佳实践

API 文档

创建全局告警通知渠道

最近更新时间:2022-06-16 06:15:03

我的收藏

1. 接口描述

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

创建全局告警通知渠道

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePrometheusGlobalNotification。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley, sa-saopaulo
InstanceId String 实例ID
Notification PrometheusNotificationItem 告警通知渠道

3. 输出参数

参数名称 类型 描述
Id String 全局告警通知渠道ID
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建全局告警通知渠道

输入示例

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

{
    "InstanceId": "xx",
    "Notification": {
        "AlertManager": {
            "Url": "xx",
            "ClusterId": "xx",
            "ClusterType": "xx"
        },
        "RepeatInterval": "xx",
        "WebHook": "xx",
        "Enabled": true,
        "PhoneNotifyOrder": [
            1
        ],
        "PhoneInnerInterval": 0,
        "PhoneCircleInterval": 0,
        "NotifyWay": [
            "xx"
        ],
        "ReceiverGroups": [
            "xx"
        ],
        "PhoneArriveNotice": true,
        "PhoneCircleTimes": 0,
        "TimeRangeStart": "xx",
        "Type": "xx",
        "TimeRangeEnd": "xx"
    }
}

输出示例

{
  "Response": {
    "Id": "xx",
    "RequestId": "xx"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.Param 参数错误。
InvalidParameter.PromInstanceNotFound Prometheus实例不存在。
目录