CreateWebhook_应用实时监控服务ARMS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

当前接口已不再维护,请使用新版告警管理的 CreateOrUpdateWebhookContact 接口创建或修改 Webhook 告警联系人。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
arms:CreateWebhook
None
全部资源
*

请求参数

字段名称字段详情
ContactNamestring

自定义联系人名称。

示例值:Webhook告警参考取值来源:
    SearchAlertContact
    DescribeContacts
    CreateOrUpdateContact
Methodstring

HTTP 请求方法。展开详情

示例值:Post
Urlstring

Method 的请求方法 URL。

示例值:https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******
HttpParamsstring

HTTP 请求参数。

示例值:[{"name":"mike"}]
HttpHeadersstring

HTTP 请求头。

示例值:[{"Content-Type":"application/json"}]
RegionIdstring

地域 ID。

示例值:cn-hangzhou
Bodystring

告警触发时发送的通知模板,当 Method 设置为 Post 时必填,可使用$content 占位符输出通知内容,不可超过 500 个字符。

示例值:{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "告警时间":"{{ .startTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }
RecoverBodystring

告警恢复时发送的通知模板,当 Method 设置为 Post 时必填,可使用$content 占位符输出通知内容,不可超过 500 个字符。

示例值:{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "恢复时间":"{{ .endTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }

返回参数

字段名称字段详情
ContactIdstring

Webhook 告警联系人 ID。

示例值:48716
RequestIdstring

请求 ID。

示例值:16AF921B-8187-489F-9913-43C808B4****

返回示例

变更历史

暂无变更历史

相关示例