查询Webhook告警联系人列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WebhookName |
string |
否 |
Webhook 告警联系人名称。 |
webhook名称 |
| Page |
integer |
是 |
查询页数。 |
1 |
| Size |
integer |
是 |
每页展示的 Webhook 告警联系人数。 |
20 |
| ContactIds |
string |
否 |
联系人 ID。 |
123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
4D6C358A-A58B-4F4B-94CE-F5AAF023**** |
| PageBean |
object |
分页对象。 |
|
| Total |
integer |
查询到的 Webhook 告警联系人总数。 |
1 |
| Page |
integer |
查询的页数。 |
1 |
| Size |
integer |
每页的 Webhook 告警联系人数。 |
20 |
| WebhookContacts |
array<object> |
Webhook 告警联系人列表。 |
|
|
array<object> |
|||
| WebhookId |
number |
Webhook 告警联系人 ID。 |
123 |
| WebhookName |
string |
Webhook 告警联系人名称。 |
webhook名称 |
| Webhook |
object |
Webhook 告警联系人详情。 |
|
| Method |
string |
HTTP 请求方法。
|
Post |
| Url |
string |
请求方法 URL。 |
https://oapi.dingtalk.com/robot/send?access_token=91f2f6**** |
| BizHeaders |
object |
HTTP 请求头。 |
[{"Content-Type":"application/json"}] |
| BizParams |
object |
HTTP 请求参数。 |
[{"content:"mike"}] |
| Body |
string |
告警通知模板。 |
{ "告警名称":"{{ .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 }}" } |
| RecoverBody |
string |
告警恢复模板。 |
{ "告警名称":"{{ .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 }}" } |
示例
正常返回示例
JSON格式
{
"RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
"PageBean": {
"Total": 1,
"Page": 1,
"Size": 20,
"WebhookContacts": [
{
"WebhookId": 123,
"WebhookName": "webhook名称",
"Webhook": {
"Method": "Post",
"Url": "https://oapi.dingtalk.com/robot/send?access_token=91f2f6****",
"BizHeaders": [
{
"Content-Type": "application/json"
}
],
"BizParams": {
"test": "test",
"test2": 1
},
"Body": "{ \"告警名称\":\"{{ .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 }}\" }",
"RecoverBody": "{ \"告警名称\":\"{{ .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 }}\" }"
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。