DescribeWebhookContacts - Application Real-Time Monitoring Service

Queries the list of webhook alert contacts.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
WebhookName	string	No	The name of the webhook alert contact.	Webhook name
Page	long	Yes	The number of the page to return.	1
Size	long	Yes	The number of alert contacts displayed on each page.	20
ContactIds	string	No	The ID of the alert contact.	123

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	4D6C358A-A58B-4F4B-94CE-F5AAF023****
PageBean	object	The returned objects.
Total	long	The total number of alert contacts.	1
Page	long	The page number of the returned page.	1
Size	long	The number of alert contacts displayed on each page.	20
WebhookContacts	array<object>	The list of webhook alert contacts.
webhookContacts	object
WebhookId	float	The ID of the webhook alert contact.	123
WebhookName	string	The name of the webhook alert contact.	Webhook name
Webhook	object	The details of the webhook alert contact.
Method	string	The HTTP request method. Get Post	Post
Url	string	The URL of the request method.	https://oapi.dingtalk.com/robot/send?access_token=91f2f6****
BizHeaders	object	The header of the HTTP request.	[{"Content-Type":"application/json"}]
BizParams	object	The parameters in the HTTP request.	[{"content:"mike"}]
Body	string	The alert notification template.	{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Alert time":"{{ .startTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }
RecoverBody	string	The notification template for clearing alerts.	{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Recovery time":"{{ .endTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }

Examples

Sample success responses

JSONformat

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "WebhookContacts": [
      {
        "WebhookId": 123,
        "WebhookName": "Webhook name\n",
        "Webhook": {
          "Method": "Post",
          "Url": "https://oapi.dingtalk.com/robot/send?access_token=91f2f6****",
          "BizHeaders": [
            {
              "Content-Type": "application/json"
            }
          ],
          "BizParams": {
            "test": "test",
            "test2": 1
          },
          "Body": "{ \"Alert name\":\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\", \"Cluster name\":\"{{ .commonLabels.clustername }} {{ end }}{{if eq \"app\" .commonLabels.\\_aliyun_arms_involvedObject_kind }}\", \"Application name\":\"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}\", \"Notification policy\":\"{{ .dispatchRuleName }}\", \"Alert time\":\"{{ .startTime }}\", \"Alert content\":\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\" }\n",
          "RecoverBody": "{ \"Alert name\":\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\", \"Cluster name\":\"{{ .commonLabels.clustername }} {{ end }}{{if eq \"app\" .commonLabels.\\_aliyun_arms_involvedObject_kind }}\", \"Application name\":\"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}\", \"Notification policy\":\"{{ .dispatchRuleName }}\", \"Recovery time\":\"{{ .endTime }}\", \"Alert content\":\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\" }\n"
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-01-07	The response structure of the API has changed	View Change Details