查询数据库会话列表

最近更新时间:2025-08-27 02:05:37

我的收藏

1. 接口描述

接口请求域名: mariadb.tencentcloudapi.com 。

本接口 (DescribeProcessList) 用于查询当前正在运行的线程(连接/查询)信息。

  • 可以根据客户端IP,DB,执行时间等信息来查询实例正在运行的线程信息。过滤信息详细请见过滤器Filter。
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的线程信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProcessList。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID。
示例值:tdsql-2gk4nxyz
NodeId String 节点ID。
示例值:681390887981
取值可参考:
查询实例详细信息
Filters.N Array of Filter
  • id

  • 按照【会话ID】进行过滤。会话ID例如:125700。


    类型:String


    必选:否


    匹配类型:精确匹配



  • user

  • 按照【用户名】进行过滤。用户名例如:root。


    类型:String


    必选:否


    匹配类型:精确匹配


  • host

  • 按照【客户端Host】进行过滤。客户端Host例如:127.0.0.1:46295。


    类型:String


    必选:否


    匹配类型:前缀匹配,例如可以查询客户端IP不加端口:127.0.0.1。


  • state

  • 按照【线程状态】进行过滤。线程状态例如:Updating。


    类型:String


    必选:否


    匹配类型:精确匹配


  • db

  • 按照【数据库名称】进行过滤。数据库名称例如:mysql。


    类型:String


    必选:否


    匹配类型:精确匹配


  • command

  • 按照【命令类型】进行过滤。命令类型例如:Query。


    类型:String


    必选:否


    匹配类型:精确匹配


  • info

  • 按照【执行语句】进行过滤。执行语句例如:select id, name from demo.table1 where id > 10。


    类型:String


    必选:否


    匹配类型:前缀匹配,例如SQL较长,可以输入SQL前缀:select id, name from demo.table1。


  • time

  • 按照【执行时间大于多少(秒)】进行过滤。例如:10,表示查询执行时间超过10秒的会话。


    类型:Integer


    必选:否


    匹配类型:范围匹配,Values值只支持输入1个。


    每次请求的Filters的上限为10,Filter.Values的上限为50。
    示例值:[{"Name": "user", "Values": ["root"]}]
    Offset Integer 偏移量,默认为0。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    ProcessList Array of Process 当前正在运行的线程(连接/查询)信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询主节点当前正在运行的线程

    输入示例

    POST / HTTP/1.1
    Host: mariadb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeProcessList
    <公共请求参数>
    
    {
        "InstanceId": "tdsql-048udnfz",
        "NodeId": "7b1f6e62b767"
    }

    输出示例

    {
        "Response": {
            "ProcessList": [
                {
                    "Command": "Sleep",
                    "Db": "mysql",
                    "Host": "9.71.144.188:55615",
                    "Id": 951069,
                    "Info": "",
                    "ProcessStartTime": "2025-06-24 11:27:26",
                    "State": "",
                    "Time": 30,
                    "User": "root"
                }
            ],
            "RequestId": "d4eb7e99-b3e6-45d6-ae6f-7358c7511cad-013"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.OperateDatabaseFailed 操作数据库失败。
    InvalidParameter 参数错误。
    InvalidParameter.InstanceNotFound 未找到请求的实例。
    UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。