调用QueryEmailVerification查询邮箱验证结果_域名(Domain)-阿里云帮助中心

调用QueryEmailVerification查询邮箱验证结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
domain:QueryEmailVerification	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	接口返回错误信息语言。取值： zh：中文。 en：英文。默认值为 en。	en
Email	string	是	待查询的邮箱。	abc@aliyun.com
UserClientIp	string	否	用户 IP，可设置为127.0.0.1。	127.0.0.1

返回参数

名称	类型	描述	示例值
	object
VerificationStatus	integer	邮箱验证状态。取值： 0：等待验证。 1：验证成功。	1
GmtCreate	string	数据库记录的邮箱创建时间。	2019-02-19 16:38:07
Email	string	查询到的邮箱。	abc@aliyun.com
EmailVerificationNo	string	邮箱验证编号（默认为系统自动生成的流水号）。	72b36ba0572e423bbb3f19640896****
ConfirmIp	string	完成邮箱验证的电脑 IP 地址。	42...31
RequestId	string	唯一请求识别码。	FC4F7D02-8A83-4E37-B935-2D48A1B8423E
UserId	string	用户 ID。	140692647406****
GmtModified	string	数据库记录的邮箱更新时间。	2019-02-19 16:40:38
SendIp	string	用户发起邮件验证的 IP 地址。	42...115
VerificationTime	string	完成邮箱验证的具体时间。	2019-02-19 16:40:38
TokenSendTime	string	邮箱验证 Token 的发送时间。	2019-02-19 16:38:07

示例

正常返回示例

JSON格式

{
  "VerificationStatus": 1,
  "GmtCreate": "2019-02-19 16:38:07",
  "Email": "abc@aliyun.com",
  "EmailVerificationNo": "72b36ba0572e423bbb3f19640896****",
  "ConfirmIp": "42.*.*.31",
  "RequestId": "FC4F7D02-8A83-4E37-B935-2D48A1B8423E",
  "UserId": "140692647406****",
  "GmtModified": "2019-02-19 16:40:38",
  "SendIp": "42.*.*.115",
  "VerificationTime": "2019-02-19 16:40:38",
  "TokenSendTime": "2019-02-19 16:38:07"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-23	OpenAPI 描述信息更新	查看变更详情