查询应用组授权邮件发送记录
功能介绍
查询应用组授权邮件发送记录。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/mails
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
单次查询的大小[1-100],默认值10。 |
|
offset |
否 |
Integer |
查询的偏移量,默认值0。 |
|
app_group_id |
是 |
String |
应用组ID。 |
|
account |
否 |
String |
用户(组)名称。 |
|
mail_send_type |
否 |
String |
授权类型: - ADD_GROUP_AUTHORIZATION 添加组授权 - DEL_GROUP_AUTHORIZATION 删除组授权。 |
|
mail_send_result |
否 |
String |
邮件发送结果(SUCCESS|FAIL)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数。 |
|
records |
Array of AuthorizationMail objects |
授权邮件信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
邮件记录id。 |
|
account |
String |
用户(组)。 |
|
account_auth_type |
String |
用户类型:
|
|
account_auth_name |
String |
授权对象名称。 |
|
app_group_id |
String |
应用组ID。 |
|
app_group_name |
String |
应用组名称。 |
|
mail_send_type |
String |
授权类型: - ADD_GROUP_AUTHORIZATION 添加组授权邮件 - DEL_GROUP_AUTHORIZATION 删除组授权邮件 - ADD_GROUP_AUTHORIZATION_SMS 添加组授权短信 - DEL_GROUP_AUTHORIZATION_SMS 删除组授权短信。 |
|
mail_send_result |
String |
发送结果。 - SUEECESS -发送成功 - FAIL -发送失败。 |
|
error_msg |
String |
报错信息。 |
|
send_at |
DateTime |
发布时间。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:415
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码:503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
状态码:200
操作成功。
{
"count" : 0,
"records" : [ {
"id" : "1",
"account" : "zhangsan*",
"account_auth_type" : "USER",
"account_auth_name" : "zhangsan*",
"app_group_id" : "1",
"app_group_name" : "流程开发应用组",
"mail_send_type" : "1",
"mail_send_result" : "SUEECESS",
"error_msg" : "error:",
"send_at" : "2022-03-07T10:40:43.858Z"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
415 |
请求中提交的资源格式不支持。 |
|
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。