ListSessions--云堡垒机-火山引擎

文档中心

立即注册

导航

ListSessions

最近更新时间：2025.05.23 17:57:33首次发布时间：2023.12.15 10:45:22

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

请求说明

请求方式：POST
请求地址：https://vbh.{RegionID}.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	否	{"NodeName": ["test"]}	筛选条件。
SessionStatus	Integer	是	0	会话类型（历史或实时会话）。支持的值包括 0 和 1，传 0 表示查询实时会话数据，传 1 表示查询从历史会话数据。
OrderBy	Object of OrderBy	否	{"Key": "Size", "Desc": true}。 Key取值可以有 StartTime、EndTime、Duration、Size。	排序信息。Key 取值可以有 StartTime、EndTime、Duration 和 Size，分别表示会话开始时间、会话结束时间、会话持续时长以及会话大小。
InstanceId	String	是	vbh-14***0042-bhjml9w7	堡垒机实例ID。

SessionFilters

参数	类型	是否必选	示例值	描述
NodeIp	Array of String	否	["2.2.2.2"]	主机Ip列表(Deprecated, use AssetAddress instead)
EndTime	String	否	2022-12-12 22:22:22	结束时间
NodeName	Array of String	否	["test"]	主机名列表(Deprecated, use AssetName instead)
Protocol	Array of String	否	["Ssh","Rdp", "Mysql"]	协议列表
RemoteIp	Array of String	否	["2.2.2.2"]	来源Ip列表
UserName	Array of String	否	["test"]	用户名列表
StartTime	String	否	2022-12-12 22:22:22	开始时间
AssetNames	Array of String	否	["test"]	资产名列表
AsssetAddresses	Array of String	否	["2.2.2.2"]	资产地址列表
NodeAccountName	Array of String	否	["test"]	主机账号列表(Deprecated, use AssetAccountName instead)
AssetAccountName	Array of String	否	["test"]	资产账号列表

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	否	key	字段
Desc	Boolean	否	true or false	倒序

请求示例

POST https://vbh.{RegionID}.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	e58d8f2a-1c46-11ec-9fda-b2031afa4b18	会话Id
ConnectionId	String	e58d8f2a-1c46-11ec-9fda-b2031afa4b18	数据面的连接Id
InstanceId	String	vbh-1400000042-bhjml9w7	堡垒机Id
NodeName	String	test	主机名
NodeIp	String	2.2.2.2	主机地址
NodeAccountName	String	test	主机账号
UserName	String	test	用户名
RemoteIp	String	2.2.2.2	来源IP
Protocol	String	Ssh	协议类型。值可为 Ssh、Rdp 或 Mysql
StartTime	String	2022-12-12 22:22:22	开始时间
EndTime	String	2022-12-12 22:22:22	结束时间
Size	Long	22	会话大小, 结束的会话才有此字段
Status	Integer	0	会话状态，取值范围:
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
    }
}

错误码

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