获取告警联系人列表。

请求说明

托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=ListContacts&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListContacts	接口名称。当前 API 的名称为 ListContacts。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量。取值范围为 0～100。默认值为 10。
Filter	Object of ContactFilter	否	-	联系人过滤条件。
SortBy	String	否	CreatedAt	查询结果是否进行排序，取值CreatedAt表示进行排序；不配置该字段表示不进行排序。
SortOrder	String	否	Asc	查询结果的排序原则，取值： Asc：表示按照升序排序。 Desc：表示按照降序排序。

ContactFilter

请求示例

返回参数

Contact

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4***	联系人 ID。
Name	String	user-demo	联系人名称。
Email	String	user-demo@example.com	联系人邮箱。
Webhook	Object of Webhook	-	联系人通用 Webhook。
ContactGroupIds	Array of String	["e28ae750-bbb8-4ff4-abf4***"]	联系人所属联系人组 ID。
LarkBotWebhook	Object of LarkBotWebhook	-	联系人飞书群组机器人 Webhook。
DingTalkBotWebhook	Object of DingTalkBotWebhook	-	联系人钉钉群组机器人 Webhook。
EmailActive	Boolean	true	联系人邮箱是否被激活，取值： true：邮箱已被激活。 fales：邮箱未被激活。
CreateTime	String	2020-01-01T00:00:00Z	联系人创建时间，RFC3339 格式。
WeComBotWebhook	Object of WeComBotWebhook	-	企业微信群组机器人 Webhook。

Webhook

参数	类型	示例值	描述
Address	String	https://www.bytedance.com/	通用 Webhook 地址。
Token	String	3KSxxx	通用 Webhook 认证 token。不能单独配置，需要与通用 Webhook 地址搭配使用。

LarkBotWebhook

参数	类型	示例值	描述
Address	String	https://open.feishu.cn/open-apis/bot/v2/hook/***	飞书群组机器人 Webhook 地址，使用方法请参见使用说明。
SecretKey	String	6KKxxx	飞书群组机器人 Webhook 秘钥。不能单独配置，需要与飞书群组机器人的 Webhook 地址搭配使用。

DingTalkBotWebhook

参数	类型	示例值	描述
Address	String	https://oapi.dingtalk.com/robot/send?access_token=***	钉钉群组机器人 Webhook 地址，使用方法请参见使用说明。
SecretKey	String	SECxxx	钉钉群组机器人 Webhook 秘钥。不能单独配置，需要与钉钉群组机器人的 Webhook 地址搭配使用。
AtMobiles	Array of String	["133********"]	被@人的手机号，该用户需要在群组内。
AtUserIds	Array of String	["********"]	被@人的用户 ID，该用户需要在群组内。

WeComBotWebhook

参数	类型	示例值	描述
Address	String	https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=***	企业微信群组机器人 Webhook 地址，使用方法请参见使用说明。
AtUserIds	Array of String	["********"]	被@人的用户 ID，该用户需要在群组内。

返回示例

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。