搜索会话

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

1. 接口描述

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

搜索会话

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
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	否	否	Datetime_iso	搜索区间的开始时间。若入参是Id，则非必传，否则为必传。示例值： 2020-12-20T19:51:23+08:00
EndTime	否	否	Datetime_iso	搜索区间的结束时间示例值： 2020-12-30T19:51:23+08:00
Kind	否	否	Uint64	会话协议类型，只能是1、2、3或4 对应关系为1-tui 2-gui 3-file 4-数据库。若入参是Id，则非必传，否则为必传。示例值： 1
Offset	否	否	Uint64	偏移量示例值： 0
Limit	否	否	Uint64	分页的页内记录数，默认为20，最大200 示例值： 10
RealName	否	否	String	姓名，长度不超过20 示例值： zhangsan
DeviceName	否	否	String	主机名，长度不超过64 示例值：运维主机
Status	否	否	Uint64	状态，1为活跃，2为结束，3为强制离线，4为其他错误示例值： 1
AppAssetUrl	否	是	String	应用资产Url 示例值： http://www.shen.com
Id	否	否	String	若入参为Id，则其他入参字段不作为搜索依据，仅按照Id来搜索会话示例值： bh-test-sid-1a2b3c
AppAssetKindSet	否	是	Array of Uint64	应用资产类型, 1-web 示例值： [1]

3. 输出参数

参数名称	类型	描述
TotalCount	Uint64	记录数示例值： 20
SessionSet	Array of SessionResult	会话信息列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 搜索session列表

搜索session列表

输入示例

POST / HTTP/1.1
Host: dasb.platformcloudapi.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
            }
        ]
    }
}