GetSessionList - 查询会话日志列表

查询数据库审计到的会话日志列表。

接口说明

使用说明

本接口用于查询会话日志列表,查询会话日志列表的所有查询条件数最多支持 30 个,例如,连接数据库的客户端的 IP 地址列表、账号的用户名列表等查询条件。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-dbaudit:GetSessionListget
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

数据库审计实例的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。接口的参数说明,请参见 DescribeRegions

注意 调用 DescribeRegions 接口查询 D100 实例支持的地域时,公共参数的 Version(API 版本)必须取值2018-03-20

cn-hangzhou
InstanceIdstring

审计的实例 ID。

您可以通过调用 DescribeInstances 接口获取实例 ID。接口的参数说明,请参见 DescribeInstances

注意 调用 DescribeInstances 接口查询 D100 实例列表时,公共参数的 Version(API 版本)必须取值2018-03-20

dbaudit-cn-78v1gc****
DbIdinteger

审计系统中配置的数据源 ID。

您可以通过调用 ListDataSources 获取数据源 ID。

1
BeginDatestring

要查询的会话日志的开始日期。格式:yyyy-MM-dd HH:mm:ss

2019-06-06 00:00:00
EndDatestring

要查询的会话日志的结束日期。格式:yyyy-MM-dd HH:mm:ss

2019-06-06 23:59:59
PageNumberinteger

设置当前页的页码。默认值为 1

1
PageSizeinteger

设置每页显示会话日志列表的数量。

默认值为 10,最大值为 100

10
SessionIdstring

会话 ID。

3011610850021000000
ActionListarray

会话状态列表,该参数中的 N 代表多个值的序号。取值:

  • -1:表示数据库会话连接失败。
  • 0:表示数据库会话连接成功。
  • 1:表示数据库会话连接退出。
string

会话状态列表,该参数中的 N 代表多个值的序号。取值:

  • -1:表示数据库会话连接失败。
  • 0:表示数据库会话连接成功。
  • 1:表示数据库会话连接退出。
0
ClientIpListarray

连接数据库的客户端的 IP 地址列表,该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。

string

连接数据库的客户端的 IP 地址列表,该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。

192.168.XX.XX
DbUserListarray

连接数据库的账号的用户名列表,该参数中的 N 代表多个值的序号。

string

连接数据库的账号的用户名列表,该参数中的 N 代表多个值的序号。

root
DbHostListarray

连接数据库的地址列表,该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。

string

连接数据库的地址列表,该参数中的 N 代表多个值的序号。支持 IPv4、IPv6 两种协议类型。

192.168.XX.XX
ClientProgramListarray

客户端连接数据库所使用的工具列表,该参数中的 N 代表多个值的序号。

string

客户端连接数据库所使用的工具列表,该参数中的 N 代表多个值的序号。

navicat
Langstring

请求和接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh

返回参数

名称类型描述示例值
object
EndDatestring

要查询的会话日志的结束日期。

2019-06-06 23:59:59
RequestIdstring

本次请求的 ID。

1B217656-2267-4FBF-B26C-CDD201BDC3B8
BeginDatestring

要查询的会话日志的开始日期。

2019-06-06 00:00:00
Incompletestring

查询结果是否精确。取值:

  • true:表示精确。
  • false:表示不精确。
true
PageNumberinteger

当前页的页码。

1
PageSizeinteger

每页显示会话日志列表的数量。

10
TotalCountlong

查询到的会话日志总数。

10000
Resultsarray<object>

查询到的会话日志列表。

Infoobject
DbIdinteger

审计系统中配置的数据源 ID。

1
LoginCodeinteger

会话连接结果。取值:

0 表示执行成功,其他数值为数据库错误码。

0
Actionstring

会话状态。取值:

-1:表示数据库会话连接失败。 0:表示数据库会话连接成功。 1:表示数据库会话连接退出。

0
ClientPortinteger

连接数据库的客户端的端口号。

15629
LoginMessagestring

会话连接错误信息。

Access denied for user 'root'@'192.168.XX.XX'(using password: YES)
DbUserstring

连接数据库的账号的用户名。

root
ServerPortinteger

数据库服务器的端口号。

3306
ClientOsUserstring

客户端系统的账号的用户名。

administrator
ServerMacstring

数据库服务器的 MAC 地址。

00163E06****
ClientProgramstring

客户端连接数据库所使用的工具。

navicat
CaptureTimestring

执行 SQL 语句的开始时间。

2019-06-06 00:00:00
ClientIpstring

连接数据库的客户端的 IP 地址。支持 IPv4、IPv6 两种协议类型。

192.168.XX.XX
ClientIpAliasstring

连接数据库的客户端 IP 别名

自定义IP别名
ServerIpstring

数据库服务器的 IP 地址。支持 IPv4、IPv6 两种协议类型。

192.168.XX.XX
SessionIdstring

数据库会话 ID。

3011610850021000000
ClientMacstring

连接数据库的客户端的 MAC 地址。

00163E06****

示例

正常返回示例

JSON格式

{
  "EndDate": "2019-06-06 23:59:59",
  "RequestId": "1B217656-2267-4FBF-B26C-CDD201BDC3B8",
  "BeginDate": "2019-06-06 00:00:00",
  "Incomplete": "true",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10000,
  "Results": [
    {
      "DbId": 1,
      "LoginCode": 0,
      "Action": "0",
      "ClientPort": 15629,
      "LoginMessage": "Access denied for user 'root'@'192.168.XX.XX'(using password: YES)",
      "DbUser": "root",
      "ServerPort": 3306,
      "ClientOsUser": "administrator",
      "ServerMac": "00163E06****",
      "ClientProgram": "navicat",
      "CaptureTime": "2019-06-06 00:00:00",
      "ClientIp": "192.168.XX.XX",
      "ClientIpAlias": "自定义IP别名",
      "ServerIp": "192.168.XX.XX",
      "SessionId": "3011610850021000000",
      "ClientMac": "00163E06****"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-16OpenAPI 描述信息更新查看变更详情