1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
查询数据库的实时线程列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-15 20:38:35。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeMySqlProcessList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| User | 否 | 是 | String | 线程的操作账号名，用于筛选线程列表。 示例值： root |
| Host | 否 | 是 | String | 线程的操作主机地址，用于筛选线程列表。 示例值： 127.0.0.1:41528 |
| DB | 否 | 是 | String | 线程的操作数据库，用于筛选线程列表。 示例值： demo_db |
| Command | 否 | 是 | String | 线程的执行类型，用于筛选线程列表。 示例值： Execute |
| Time | 否 | 是 | Uint64 | 线程的操作时长最小值，单位秒，用于筛选操作时长大于该值的线程列表。 示例值： 10 |
| Info | 否 | 是 | String | 线程的操作语句，用于筛选线程列表。 示例值： DELETE FROM test WHERE time<=1 |
| InstanceId | 是 | 否 | String | 实例ID。 示例值： shard-lm6o3jwi |
| ID | 否 | 是 | Uint64 | 线程的ID，用于筛选线程列表。 示例值： 20 |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： mariadb |
| StatDimensions | 否 | 是 | Array of StatDimension | 会话统计的维度信息,可以多个维度。 示例值：查看 |
| State | 否 | 是 | String | 线程的操作状态，用于筛选线程列表。 示例值： updating |
| Limit | 否 | 是 | Uint64 | 返回数量，默认20。 示例值： 20 |
| ClusterId | 否 | 是 | String | 集群 ID。 示例值： tdsqlshard-70m8bedq |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ProcessList | Array of MySqlProcess | 实时线程列表。 示例值：查看 |
| Statistics | Array of StatisticInfo | sql会话统计信息。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |