SendValidationMessage--托管 Prometheus-火山引擎

文档中心

立即注册

导航

SendValidationMessage

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

发送邮箱验证信息。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	SendValidationMessage	接口名称。当前 API 的名称为 `SendValidationMessage`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Type	String	是	Email	发送验证消息类型，固定取值为`Email`。
Destination	String	是	user-demo@example.com	联系人邮箱。

请求示例

POST https://open.volcengineapi.com/?Action=SendValidationMessage&Version=2021-03-03
Content-Type: application/json
{
    "Type": "Email",
    "Destination": "user-demo@example.com"
}

返回参数

参数类型示例值描述

参数	类型	示例值	描述
SendStatus	String	MessageSucceed.Email	发送邮箱认证信息状态码： AlreadyActive.Email：邮箱已激活 MessageFailed.Email：发送验证邮件失败 LimitExceeded.Email：发送验证邮件过于频繁 MessageSucceed.Email：发送验证邮件成功
Message	String	-	发送邮箱认证信息错误原因。当`SendStatus`不等于`MessageSucceed.Email`时有值。

SendStatus

String

MessageSucceed.Email

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

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

Message

String

发送邮箱认证信息错误原因。
当SendStatus不等于MessageSucceed.Email时有值。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "SendValidationMessage",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "SendStatus": "MessageSucceed.Email",
        "Message": ""
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
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 服务。
404	NotFound.Id	The specified Contact/ContactGroup {{Id}} is not found.	未找到指定联系人/联系人组。
429	LimitExceeded.Email	The same email address should not be validated more than once in 1 minute, please try it later.	同一电子邮件地址在 1 分钟内不应验证超过一次，请稍后再试。