文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 查询实例会话 - ConnQueryProcessList
更新时间：2025-12-04 GMT+08:00
查看PDF
分享

查询实例会话 - ConnQueryProcessList

功能介绍

查询实例会话。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das:clouddba:listProcess

    list

    instance

    -

    -

    -

URI

GET /v3/{project_id}/connections/{connection_id}/instance/query-process-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

connection_id

是

String

参数解释：

连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接接口创建）。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

user

否

String

参数解释：

指定用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

host

否

String

参数解释：

指定访问来源。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db

否

String

参数解释：

指定数据库。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

state

否

String

参数解释：

指定状态。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

command

否

String

参数解释：

指定命令。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keywords

否

String

参数解释：

模糊搜索条件。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

show_all

否

Boolean

参数解释：

是否显示全部。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

false

show_no_pid

否

Boolean

参数解释：

是否显示没有后台进程的会话。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

false

time

否

String

参数解释：

指定慢sql阈值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0

per_page

否

String

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

[0, 100]，实际取决于查询。

默认取值：

不涉及。

cur_page

否

String

参数解释：

页码。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

order_by

否

String

参数解释：

选择排序列。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

time

order

否

String

参数解释：

排序顺序。

约束限制：

不涉及。

取值范围：

  • asc：升序
  • desc：降序

默认取值：

desc

node_id

否

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

node_role

否

String

参数解释：

节点类型。

约束限制：

不涉及。

取值范围：

  • master：主节点
  • slave：副节点
  • readreplica：只读节点

默认取值：

不涉及。

请求参数

无。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

process_info_list

Array of 表4 objects

参数解释：

会话信息列表。

取值范围：

不涉及。

total

Long

参数解释：

根据条件筛选的总会话数。

取值范围：

不涉及。

user_info_list

Array of Strings

参数解释：

用户列表。

取值范围：

不涉及。

db_info_list

Array of Strings

参数解释：

数据库列表。

取值范围：

不涉及。

host_info_list

Array of Strings

参数解释：

来源IP列表。

取值范围：

不涉及。

state_info_list

Array of Strings

参数解释：

状态列表。

取值范围：

不涉及。

command_info_list

Array of Strings

参数解释：

命令列表。

取值范围：

不涉及。

session_exec_time

Array of Strings

参数解释：

会话执行时间比例。

取值范围：

不涉及。

idle_session

Long

参数解释：

空闲会话数。

取值范围：

不涉及。

active_session

Long

参数解释：

运行会话数。

取值范围：

不涉及。

summary

Array of 表5 objects

参数解释：

概要。

取值范围：

不涉及。

user_stats

Array of 表6 objects

参数解释：

按用户统计信息。

取值范围：

不涉及。

host_stats

Array of 表6 objects

参数解释：

按访问来源统计。

取值范围：

不涉及。

db_stats

Array of 表6 objects

参数解释：

按数据库统计。

取值范围：

不涉及。

show_version_support_message

Boolean

参数解释：

是否显示版本支持信息。

取值范围：

不涉及。

show_warn_message

Boolean

参数解释：

是否告警信息。

取值范围：

不涉及。
表4 ProcessInfo

参数

参数类型

描述

id

String

参数解释：

会话ID。

取值范围：

不涉及。

user

String

参数解释：

用户。

取值范围：

不涉及。

host

String

参数解释：

连接库的IP和port。

取值范围：

不涉及。

db

String

参数解释：

数据库。

取值范围：

不涉及。

command

String

参数解释：

当前执行的命令。

取值范围：

不涉及。

time

String

参数解释：

会话运行时间。

取值范围：

不涉及。

state

String

参数解释：

执行状态。

取值范围：

不涉及。

info

String

参数解释：

执行的SQL。

取值范围：

不涉及。

trx_duration

String

参数解释：

事务持续时间。

取值范围：

不涉及。
表5 ProcessSummary

参数

参数类型

描述

key

String

参数解释：

概要参数名。

取值范围：

不涉及。

value

Long

参数解释：

概要参数值。

取值范围：

不涉及。
表6 ProcessStats

参数

参数类型

描述

key

String

参数解释：

统计项名称。

取值范围：

不涉及。

value

String

参数解释：

统计项值。

取值范围：

不涉及。

active_count

Long

参数解释：

活跃数。

取值范围：

不涉及。

total_count

Long

参数解释：

总数。

取值范围：

不涉及。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/instance/query-process-list?cur_page=1&per_page=10&show_all=true&order_by=time&order=desc&keywords=&show_no_pid=false&hide_sys=true&db=&user=&host=&state=

响应示例

状态码： 200

Success.

{
    "process_info_list": [
        {
            "id": "6453001",
            "user": "root",
            "host": "100.79.0.248:41926",
            "db": "--",
            "command": "Sleep",
            "time": "38",
            "state": "",
            "info": "",
            "trx_duration": "0",
            "longTime": 38,
            "longTrxDuration": 0
        }
    ],
    "total": 1,
    "user_info_list": [
        "root"
    ],
    "db_info_list": [
        "--"
    ],
    "host_info_list": [
        "100.79.0.248"
    ],
    "state_info_list": [],
    "command_info_list": [
        "Sleep",
        "Query"
    ],
    "session_exec_time": {
        "less500ms": 0,
        "more60s": 0,
        "less60s": 1,
        "less100ms": 0,
        "less5s": 0,
        "less1s": 0
    },
    "idle_session": 1,
    "active_session": 0,
    "summary": [
        {
            "key": "totalSession",
            "value": 1
        },
        {
            "key": "activeSession",
            "value": 0
        },
        {
            "key": "maxActiveSessionTime",
            "value": 38
        }
    ],
    "user_stats": [
        {
            "key": "user",
            "value": "root",
            "active_count": 0,
            "total_count": 1
        }
    ],
    "host_stats": [
        {
            "key": "host",
            "value": "100.79.0.248",
            "active_count": 0,
            "total_count": 1
        }
    ],
    "db_stats": [
        {
            "key": "db",
            "value": "--",
            "active_count": 0,
            "total_count": 1
        }
    ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 云DBA

相关文档