Update alerting contacts.

Request descriptions

Volcengine Managed Service for Prometheus has been deployed in multiple regions worldwide, aiming to provide you with an experience of higher stability and lower latency. You can choose an access point that is the most optimal for the region of your services according to the Service addresses document.

Request method: POST

Request URL: https://vmp.cn-beijing.volcengineapi.com/?Action=UpdateContact&Version=2021-03-03

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	UpdateContact	API name. The API name is UpdateContact.
Version	String	Yes	2021-03-03	API version. The API version is 2021-03-03.
Id	String	Yes	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	ID of the contact person.
Name	String	No	user-demo	Name of the contact person. It can only contain uppercase and lowercase letters, Chinese characters, numbers, hyphens, and underscores. It cannot start with numbers, hyphens, underscores (_), or other special characters. It must be less than 128 characters in length. It needs to be unique under the same account.
Email	String	No	user-demo@example.com	A valid email address of the contact person.
Webhook	Object of Webhook	No	-	Generic webhook for contacts.
ContactGroupIds	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	The contact group ID to which the contact person belongs.
LarkBotWebhook	Object of LarkBotWebhook	No	-	Webhook configuration of the Feishu group bot for the contact.
DingTalkBotWebhook	Object of DingTalkBotWebhook	No	-	Webhook configuration of the DingTalk group bot for the contact.
WeComBotWebhook	Object of WeComBotWebhook	No	-	Webhook configuration of the WeCom group bot for the contact.

Webhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://www.bytedance.com/	Generic webhook address.
Token	String	No	3KSxxx	Authentication token for the generic webhook. It must be used together with the generic webhook address.

LarkBotWebhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://open.feishu.cn/open-apis/bot/v2/hook/***	The webhook address of the Feishu group bot. See User Guide for details.
SecretKey	String	No	6KKxxx	A webhook secret key for the Feishu group bot. It needs to always be used together with the webhook address of the Feishu group bot.

DingTalkBotWebhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://oapi.dingtalk.com/robot/send?access_token=***	The webhook address of the DingTalk group bot. See User Guide for details.
SecretKey	String	No	SECxxx	A webhook secret key for DingTalk robot. It needs to always be used together with the webhook address of DingTalk robot.
AtMobiles	Array of String	No	["133********"]	The phone number of the user to be @mentioned. The user must be in the group.
AtUserIds	Array of String	No	["********"]	The ID of the user who is about to be @mentioned in the group.

WeComBotWebhook

Parameter	Type	Required	Sample value	Description
Address	String	Yes	https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=***	The Webhook address of WeCom robot. See User Guide for details.
AtUserIds	Array of String	No	["********"]	The ID of the user who is about to be @mentioned in the group.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	ID of the contact person.
SendStatus	String	MessageSucceed.Email	The status returned when sending verification emails: AlreadyActive.Email: the email address has already been verified MessageFailed.Email: failed to send the verification email LimitExceeded.Email: email sending is too frequent MessageSucceed.Email: verification email has been sent successfully
Message	String	The same email address should not be validated more than once in 1 minute, please try it later.	The reason the error occurred when sending the verification email. This parameter has a value when SendStatus is not MessageSucceed.Email.

Sample responses

Error codes

The error codes for current API only are listed in the table below. See Public error codes to view error codes for any APIs.

HTTP status codes	Error codes	Error message	Description
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	The input is invalid. For example, the workspace name does not meet the requirements.
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	Missing required parameters.
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	The account is not subscribed to the VMP Service.
404	NotFound.Id	The specified Contact/ContactGroup {{Id}} is not found.	The specified contact person/group was not found.
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	The specified name has already been used by an existing resource.