CreateOrUpdateWebhookContact - Application Real-Time Monitoring Service

Creates or modifies a webhook alert contact.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:CreateContact	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
WebhookId	long	No	The ID of the webhook alert contact. If you do not specify this parameter, a new webhook alert contact is created. If you specify this parameter, the specified webhook alert contact is modified.	123
WebhookName	string	Yes	The name of the webhook alert contact.	Webhook alert
Method	string	Yes	The HTTP request method. Post Get	Post
Url	string	Yes	The URL of the HTTP request method.	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
BizHeaders	string	No	The HTTP request headers.	[{"Content-Type":"application/json;charset=utf-8"}]
BizParams	string	No	The parameters in the HTTP request.	[{"content":"mike"}]
Body	string	No	The notification template that is sent when an alert is triggered. This parameter is required if the Method parameter is set to Post. You can use the `$content` placeholder to specify the notification content. The content cannot exceed 500 characters in length. For more information, see Variable description of a 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	No	The notification template that is sent when an alert is resolved. This parameter is required if the Method parameter is set to Post. You can use the `$content` placeholder to specify the notification content. The content cannot exceed 500 characters in length. For more information, see Variable description of a 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 }}", "Recovery time":"{{ .endTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	16AF921B-8187-489F-9913-43C808B4****
WebhookContact	object	The returned webhook alert contact.
WebhookId	float	The ID of the webhook alert contact.	123
WebhookName	string	The name of the webhook alert contact.	Webhook alert
Webhook	object	The information about the webhook alert contact.
Method	string	The HTTP request method. Post Get	Post
Url	string	The URL of the request method.	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
BizHeaders	string	The HTTP request headers.	[{"Content-Type":"application/json;charset=utf-8"}]
BizParams	string	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": "16AF921B-8187-489F-9913-43C808B4****",
  "WebhookContact": {
    "WebhookId": 123,
    "WebhookName": "Webhook alert\n",
    "Webhook": {
      "Method": "Post",
      "Url": "https://oapi.dingtalk.com/robot/send?access_token=e1a049121******",
      "BizHeaders": "[{\"Content-Type\":\"application/json;charset=utf-8\"}]",
      "BizParams": "[{\"content\":\"mike\"}]",
      "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

No change history