文档中心

ListSessions

最近更新时间：2024.04.16 19:47:32

首次发布时间：2023.12.15 10:45:22

获取会话列表，可根据会话开始时间、结束时间、用户名、来源 IP 等筛选条件查询云堡垒机中的会话列表，并且能够按字段进行排序。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListSessions&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListSessions	接口名称。当前 API 的名称为 `ListSessions`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	1	分页查询时每页显示的记录数。最小值：1 最大值：100 默认值：10
Filter	Object of SessionFilters	否		筛选条件。
SessionStatus	Integer	是	0	会话类型（历史或实时会话）。支持的值包括 0 和 1，传 0 表示查询实时会话数据，传 1 表示查询从历史会话数据。
OrderBy	Object of OrderBy	否		排序信息。Key 取值可以有 StartTime、EndTime、Duration 和 Size，分别表示会话开始时间、会话结束时间、会话持续时长以及会话大小。
InstanceId	String	是	vbh-14***0042-bhjml9w7	堡垒机实例ID。

SessionFilters

参数	类型	是否必选	示例值	描述
StartTime	String	否	2023-09-12 10:34:30	会话开始时间。
EndTime	String	否	2023-09-12 10:34:30	会话结束时间。
NodeIp	Array of String	否	["192.168.1.2"]	主机 IP 地址列表。
NodeName	Array of String	否	["vbh"]	主机名列表。
NodeAccountName	Array of String	否	["root"]	主机账号名列表。
UserName	Array of String	否	["John"]	用户名列表。
RemoteIp	Array of String	否	["192.168.4.2"]	来源 IP 列表。
Protocol	Array of String	否	["SSH"]	协议列表，支持的协值： SFTP：sftp 协议。 SSH：ssh 协议。 RDP：rdp 协议。

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	否	Name	排序字段
Desc	Boolean	否	true	是否进行降序排列。取值: true：降序 false：升序

参数

类型

是否必选

示例值

描述

Key

String

否

Name

排序字段

Desc

Boolean

否

true

是否进行降序排列。取值:

true：降序
false：升序

请求示例

POST https://open.volcengineapi.com/?Action=ListSessions&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 1,
    "Filter": {
        "StartTime": "2023-09-12 10:34:30",
        "EndTime": "2023-09-12 10:34:30",
        "NodeIp": ["192.168.1.2"],
        "NodeName": ["vbh"],
        "NodeAccountName": ["root"],
        "UserName": ["John"],
        "RemoteIp": ["192.168.4.2"],
        "Protocol": ["SSH"]
    },
    "SessionStatus": 0,
    "OrderBy": {
        "Key": "Name",
        "Desc": true
    },
    "InstanceId": "vbh-14****0042-bhjml9w7"
}

返回参数

参数	类型	示例值	描述
Items	Array of SessionWithDuration		会话列表
TotalCount	Long	2	返回数据列表的总量。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	每页显示的数量。

SessionWithDuration

参数	类型	示例值	描述
Id	String	e65**5-4d0a-11ec-a0a3-4e95***efd	会话 ID。
ConnectionId	String	20230208205633b	云堡垒机实例的连接 ID。
InstanceId	String	vbh-14000**-jml9w7	云堡垒机实例 ID。
NodeName	String	vbh	主机名称。
NodeIp	String	192.168.3.123	主机 IP。
NodeAccountName	String	root	主机账号名。
UserName	String	vbh	用户名。
RemoteIp	String	192.168.3.123	来源IP。
Protocol	String	SSH	协议类型，取值： SFTP：sftp 协议。 SSH：ssh 协议。 RDP：rdp 协议。
StartTime	String	2023-09-12 10:34:30	会话开始时间。
EndTime	String	2023-09-12 10:34:30	会话结束时间。
Size	Long	22	会话大小, 结束的会话才有此字段。单位：Byte。
Status	Integer	0	会话状态，取值： 0：表示会话为实时会话，尚未终止。 1：表示该会话为历史会话，已经终止。
Duration	Long	100	会话时，单位毫秒。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListSessions",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "7f****fc-c0b7-11ec-b792-e*****1bf10a",
                "ConnectionId": "20230208205633b",
                "InstanceId": "vbh-14000****-**jml9w7",
                "NodeName": "node-mlt",
                "NodeIp": "192.168.3.123",
                "NodeAccountName": "admin",
                "UserName": "John",
                "RemoteIp": "192.168.3.123",
                "Protocol": "SSH",
                "StartTime": "2023-09-12 10:34:30",
                "EndTime": "2023-09-12 10:34:30",
                "Size": 22,
                "Status": 0,
                "Duration": 100
            }
        ],
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。