调用DescribeWebhookContacts接口查询Webhook告警联系人列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeWebhookContacts

系统规定参数。取值:DescribeWebhookContacts

WebhookName String webhook名称

Webhook告警联系人名称。

Page Long 1

查询页数。

Size Long 20

每页展示的Webhook告警联系人数。

返回数据

名称 类型 示例值 描述
RequestId String 4D6C358A-A58B-4F4B-94CE-F5AAF023****

请求ID。

PageBean Object

分页对象。

Total Long 1

查询到的Webhook告警联系人总数。

Page Long 1

查询的页数。

Size Long 20

每页的Webhook告警联系人数。

WebhookContacts Array of webhookContacts

Webhook告警联系人列表。

WebhookId Float 123

Webhook告警联系人ID。

WebhookName String webhook名称

Webhook告警联系人名称。

Webhook Object

Webhook告警联系人详情。

Method String Post

HTTP请求方法。

  • Get
  • Post
Url String https://oapi.dingtalk.com/robot/send?access_token=91f2f6****

请求方法URL。

BizHeaders String [{"Content-Type":"application/json"}]

HTTP请求头。

BizParams String [{"content:"mike"}]

HTTP请求参数。

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 }}" }

告警恢复模板。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWebhookContacts
&WebhookName=webhook名称
&Page=1
&Size=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeWebhookContactsResponse>
    <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>
    <PageBean>
        <Total>1</Total>
        <Page>1</Page>
        <Size>20</Size>
        <WebhookContacts>
            <WebhookId>123</WebhookId>
            <WebhookName>webhook名称</WebhookName>
            <Webhook>
                <Method>Post</Method>
                <Url>https://oapi.dingtalk.com/robot/send?access_token=91f2f6****</Url>
                <BizHeaders>[{"Content-Type":"application/json"}]</BizHeaders>
                <BizParams>[{"content:"mike"}]</BizParams>
                <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 }}" }</Body>
                <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 }}" }</RecoverBody>
            </Webhook>
        </WebhookContacts>
    </PageBean>
</DescribeWebhookContactsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "[{\"content:\"mike\"}]",
        "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 }}\" }"
      }
    } ]
  }
}