ListContacts--托管 Prometheus-火山引擎

文档中心

立即注册

导航

ListContacts

最近更新时间：2024.09.03 15:42:17首次发布时间：2023.06.30 15:23:34

获取告警联系人列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListContacts&Version=2021-03-03

请求参数

参数	类型	是否必选	示例值	描述
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

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	按联系人 ID 过滤，精确查询。
Name	String	否	user-demo	按联系人名称过滤，模糊查询。
Email	String	否	user-demo@example.com	按联系人邮箱过滤，模糊查询。

请求示例

POST https://open.volcengineapi.com/?Action=CreateContact&Version=2021-03-03
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Ids": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "Name": "user-demo",
        "Email": "user-demo@example.com"
    },
    "SortBy": "CreatedAt",
    "SortOrder": "Asc"
}

返回参数

参数	类型	示例值	描述
Total	Long	100	联系人总数。
Items	Array of Contact	-	联系人列表。

Contact

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	联系人 ID。
Name	String	user-demo	联系人名称。
Email	String	user-demo@example.com	联系人邮箱。
Webhook	Object of Webhook	-	联系人通用 Webhook。
ContactGroupIds	Array of String	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	联系人所属联系人组 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/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListContacts",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "Name": "user-demo",
                "Email": "user-demo@example.com",
                "Webhook": {
                    "Token": "3KSxxx",
                    "Address": "https://www.bytedance.com/"
                },
                "CreateTime": "2020-01-01T00:00:00Z",
                "EmailActive": true,
                "LarkBotWebhook": {
                    "Address": "https://open.feishu.cn/open-apis/bot/v2/hook/***",
                    "SecretKey": "6KKxxx"
                },
                "ContactGroupIds": [
                    "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
                ],
                "WeComBotWebhook": {
                    "Address": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=***",
                    "AtUserIds": [
                        "********"
                    ]
                },
                "DingTalkBotWebhook": {
                    "Address": "https://oapi.dingtalk.com/robot/send?access_token=***",
                    "AtMobiles": [
                        "133********"
                    ],
                    "AtUserIds": [
                        "********"
                    ],
                    "SecretKey": "SECxxx"
                }
            }
        ]
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
403	ProductUnsubscribed	You are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。