有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: cwp.tencentcloudapi.com 。

获取登录审计列表

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHostLoginList。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。
Limit Integer 需要返回的数量,最大值为100
示例值:10
Offset Integer 偏移量,默认为0。
示例值:1
Filters.N Array of Filter 过滤条件。
  • IpOrAlias - String - 是否必填:否 - 主机ip或别名筛选
  • Uuid - String - 是否必填:否 - 主机安全唯一Uuid
  • Quuid - String - 是否必填:否 - 云服务器uuid
  • UserName - String - 是否必填:否 - 用户名筛选
  • LoginTimeBegin - String - 是否必填:否 - 按照修改时间段筛选,开始时间
  • LoginTimeEnd - String - 是否必填:否 - 按照修改时间段筛选,结束时间
  • SrcIp - String - 是否必填:否 - 来源ip筛选
  • Status - int - 是否必填:否 - 状态筛选1:正常登录;5:已加白,14:已处理,15:已忽略
  • RiskLevel - int - 是否必填:否 - 状态筛选0:高危;1:可疑

  • 示例值:[]
    Order String 排序方式:根据请求次数排序:asc-升序/desc-降序
    示例值:asc
    By String 排序字段:LoginTime-发生时间
    示例值:LoginTime

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 总数
    示例值:1
    HostLoginList Array of HostLoginList 登录审计列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 登录审计列表

    登录审计列表

    输入示例

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeHostLoginList
    <公共请求参数>
    
    {
        "Limit": 1,
        "Filters": [
            {
                "Values": [
                    "abc"
                ],
                "Name": "abc",
                "ExactMatch": true
            }
        ],
        "Offset": 1
    }

    输出示例

    {
        "Response": {
            "HostLoginList": [
                {
                    "Id": 202008000000022,
                    "Uuid": "5cc8e4d2-311f-11ea-922b-98be9421969a",
                    "MachineIp": "10.104.194.49",
                    "MachineName": "v_lwjlin_centos_林",
                    "UserName": "root",
                    "SrcIp": "120.229.227.225",
                    "Status": 2,
                    "Country": 1,
                    "City": 216,
                    "Province": 19,
                    "LoginTime": "2020-02-20 14:51:35",
                    "ModifyTime": "2020-02-20 14:51:35"
                }
            ],
            "RequestId": "4234234",
            "TotalCount": 446
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.DateRange 时间区间格式错误。
    InvalidParameter.MissingParameter 参数缺失。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。