查询登录日志

最近更新时间: 2026-09-17 00:00:19

1. 接口描述

接口请求域名： bhsaas.api3.fincloud.tencent.cn。

查询登录日志

默认接口请求频率限制：20次/秒。

接口更新时间：2023-09-05 03:35:34。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeLoginEvent
Version	是	否	String	公共参数，本接口取值：2019-10-18
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
UserName	否	否	String	用户名，如果不包含其他条件时对user_name or real_name两个字段模糊查询示例值： zhangsan
RealName	否	否	String	姓名，模糊查询示例值：张三
StartTime	否	否	Datetime_iso	查询时间范围，起始时间示例值： 2021-02-04T15:23:52+08:00
EndTime	否	否	Datetime_iso	查询时间范围，结束时间示例值： 2021-02-04T15:23:52+08:00
SourceIp	否	否	String	来源IP，模糊查询示例值： 10.0.0.1
Entry	否	否	Uint64	登录入口：1-字符界面,2-图形界面，3-web页面, 4-API 示例值： 1
Result	否	否	Uint64	操作结果，1-成功，2-失败示例值： 1
Offset	否	否	Uint64	分页偏移位置，默认值为0 示例值： 0
Limit	否	否	Uint64	分页每页记录数，默认20 示例值： 20

3. 输出参数

参数名称	类型	描述
LoginEventSet	Array of LoginEvent	登录日志列表示例值：查看
TotalCount	Uint64	总记录数示例值： 10
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
InternalError	内部错误。
ResourceNotFound	资源不存在。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 查询登录日志列表

输入示例

POST / HTTP/1.1
Host: dasb.platformcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoginEvent
<公共请求参数>

{
    "UserName": "msu"
}

输出示例

{
    "Response": {
        "TotalCount": 1, 
        "LoginEventSet": [
            {
                "UserName": "xx", 
                "RealName": "xx", 
                "Result": 1, 
                "Time": "2020-09-22T00:00:00+00:00", 
                "Entry": 1, 
                "SourceIp": "xx"
            }
        ], 
        "RequestId": "xx"
    }
}