堡垒机
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 堡垒机 > API 文档 > 其他接口 > 搜索会话

搜索会话

最近更新时间：2024-03-12 01:24:15

我的收藏

本页目录：

1. 接口描述

接口请求域名： dasb.tencentcloudapi.com 。

搜索会话

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SearchSession。
Version 是 String 公共参数，本接口取值：2019-10-18。
Region 是 String 公共参数，详见产品支持的 地域列表。
PrivateIp 否 String 内部Ip
示例值：127.0.0.1
PublicIp 否 String 外部Ip
示例值：127.0.0.1
UserName 否 String 用户名，长度不超过20
示例值：user1
Account 否 String 账号，长度不超过64
示例值：administrator
FromIp 否 String 来源Ip
示例值：127.0.0.1
StartTime 否 Timestamp ISO8601 搜索区间的开始时间。若入参是Id，则非必传，否则为必传。
示例值：2020-01-02T01:01:01Z
EndTime 否 Timestamp ISO8601 搜索区间的结束时间
示例值：2020-01-02T01:01:01Z
Kind 否 Integer 会话协议类型，只能是1、2、3或4 对应关系为1-tui 2-gui 3-file 4-数据库。若入参是Id，则非必传，否则为必传。
示例值：1
Offset 否 Integer 偏移量
示例值：0
Limit 否 Integer 分页的页内记录数，默认为20，最大200
示例值：10
RealName 否 String 姓名，长度不超过20
示例值：xxx
DeviceName 否 String 主机名，长度不超过64
示例值：xxx
Status 否 Integer 状态，1为活跃，2为结束，3为强制离线，4为其他错误
示例值：1
Id 否 String 若入参为Id，则其他入参字段不作为搜索依据，仅按照Id来搜索会话
示例值：xxx

3. 输出参数

参数名称 类型 描述
TotalCount Integer 记录数
示例值：20
SessionSet Array of SessionResult 会话信息列表
示例值：[]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 搜索session列表

搜索session列表

输入示例

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

{
    "UserName": "user1",
    "Account": "admistrator",
    "PrivateIp": "127.0.0.1",
    "PublicIp": "192.168.12.12",
    "FromIp": "192.12.12.12",
    "StartTime": "2020-01-02T01:01:01Z",
    "EndTime": "2020-01-02T01:02:00Z",
    "Kind": 1,
    "Offset": 0,
    "Limit": 5
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "SessionSet": [
            {
                "UserName": "xx",
                "DeviceName": "xx",
                "Account": "xx",
                "Protocol": "xx",
                "RealName": "xx",
                "Status": 1,
                "InstanceId": "xx",
                "FromIp": "xx",
                "DangerCount": 1,
                "PublicIp": "xx",
                "Count": 1,
                "StartTime": "xx",
                "ApCode": "xx",
                "Duration": 0.0,
                "PrivateIp": "xx",
                "EndTime": "xx",
                "Id": "xx",
                "Size": 1
            }
        ]
    }
}

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 参数错误。
InvalidParameterValue 参数取值错误。
中国站