You need to enable JavaScript to run this app.
导航
托管 Prometheus
  • 文档首页
    • /
  • 托管 Prometheus

SendValidationMessage

最近更新时间：2024.04.19 11:53:54

首次发布时间：2023.06.30 15:23:34

我的收藏

发送邮箱验证信息。

请求说明

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

请求参数

参数名称类型是否必选示例值描述
ActionString是SendValidationMessage公共参数，本接口值：SendValidationMessage。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
TypeString是Email发送验证消息类型，固定取值为Email。
DestinationString是test@123.com联系人邮箱。

请求示例

POST /?Action=SendValidationMessage&Version=2021-03-03
Content-Type:application/json
{
    "Type": " Email",
    "Destination": "test@123.com"
}

返回参数

参数名称类型示例值描述

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": "202211302208xxxx",
        "Action": "SendValidationMessage",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "SendStatus": " MessageSucceed.Email"
    }
}

错误码

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

HTTP 状态码错误码错误信息描述
400MissingParameter.{{parameter}}The required parameter {{parameter}} is missing.缺少必要的参数。
403ProductUnsubscribedYou 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 服务。
429LimitExceeded.EmailThe same email address should not be validated more than once in 1 minute, please try it later.同一电子邮件地址在 1 分钟内不应验证超过一次。