CreateContact--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateContact

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

创建告警联系人。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateContact	接口名称。当前 API 的名称为 `CreateContact`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Name	String	是	user-demo	联系人名称。支持大小写字母、中文、数字、中划线或下划线。不能以数字、中划线、下划线或其他特殊字符开头。长度小于 128 个字符。账户内唯一。
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。
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，该用户需要在群组内。

请求示例

POST https://open.volcengineapi.com/?Action=CreateContact&Version=2021-03-03
Content-Type: application/json
{
    "Name": "user-demo",
    "Email": "user-demo@example.com",
    "Webhook": {
        "Token": "3KSxxx",
        "Address": "https://www.bytedance.com/"
    },
    "ContactGroupIds": [
        "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    ],
    "LarkBotWebhook": {
        "Address": "https://open.feishu.cn/open-apis/bot/v2/hook/***",
        "SecretKey": "6KKxxx"
    },
    "DingTalkBotWebhook": {
        "Address": "https://oapi.dingtalk.com/robot/send?access_token=***",
        "AtMobiles": [
            "133********"
        ],
        "AtUserIds": [
            "********"
        ],
        "SecretKey": "SECxxx"
    },
    "WeComBotWebhook": {
        "Address": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxx",
        "AtUserIds": [
            "********"
        ]
    }
}

返回参数

参数类型示例值描述

Id String e28ae750-bbb8-4ff4-abf4-1e0e0f88808c 联系人 ID。

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	联系人 ID。
SendStatus	String	MessageSucceed.Email	发送邮箱认证信息状态码： AlreadyActive.Email：邮箱已激活 MessageFailed.Email：发送验证邮件失败 LimitExceeded.Email：发送验证邮件过于频繁 MessageSucceed.Email：发送验证邮件成功
Message	String	The same email address should not be validated more than once in 1 minute, please try it later.	发送邮箱认证信息错误原因信息。当`SendStatus`不等于 `MessageSucceed.Email`时，该参数有值。

SendStatus

String

MessageSucceed.Email

发送邮箱认证信息状态码：

AlreadyActive.Email：邮箱已激活
MessageFailed.Email：发送验证邮件失败
LimitExceeded.Email：发送验证邮件过于频繁
MessageSucceed.Email：发送验证邮件成功

Message

String

The same email address should not be validated more than once in 1 minute, please try it later.

发送邮箱认证信息错误原因信息。

当SendStatus不等于 MessageSucceed.Email时，该参数有值。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateContact",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
        "SendStatus": "MessageSucceed.Email",
        "Message": "The same email address should not be validated more than once in 1 minute, please try it later."
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。
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 服务。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。