文档首页/ 云数据库 TaurusDB/ API参考/ API/ 流量管理/ 查询大事务执行进度 - ShowTaurusDbTxnProgress
更新时间:2026-08-17 GMT+08:00
分享

查询大事务执行进度 - ShowTaurusDbTxnProgress

功能介绍

根据事务ID列表查询对应事务的执行进度,目前仅支持查询回滚事务的执行进度。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:listProcesses

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:listProcesses

    -

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/txn-progress

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

获取方法请参见查询实例列表

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

node_id

String

参数解释

节点ID。

获取方法请参见查询实例详情

约束限制

节点角色必须为主节点。

取值范围

只能由英文字母、数字组成,前面为UUID,后缀为no07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释

指定查询的事务动作类型。

约束限制

不涉及。

取值范围

rollback:查询事务的回滚进度。

默认取值

rollback。

transaction_ids

Array of strings

参数解释

事务唯一标识列表。

  • 列表为空/不传:将执行全量查询,并根据limit和offset分页参数返回当前所有处于执行中的事务信息。

  • 列表不为空:将精确匹配并返回transaction_ids中指定的事务信息,此时分页参数(limit/offset)无效。

约束限制

单次查询最多支持100个事务ID。

取值范围

符合事务ID格式的字符串列表。

limit

Integer

参数解释

查询记录数。

约束限制

必须为整数,不能为负数。

取值范围

1-100。

默认取值

100。

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

必须为整数,不能为负数。

取值范围

≥0。

默认取值

0。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

transactions

Array of TxnItem objects

参数解释

处于活跃状态(回滚中)的事务进度列表。如果输入的ID已结束或不存在,则不在此列表中返回。

total_count

Integer

参数解释

满足查询条件的事务记录总数。

取值范围

0~100。

表5 TxnItem

参数

参数类型

描述

trx_id

String

参数解释

事务的唯一标识。

取值范围

不涉及。

estimated_remaining_time

Long

参数解释

预计剩余完成时间(秒)。

取值范围

>0。

trx_mysql_thread_id

Long

参数解释

用户会话线程ID。

取值范围

不涉及。

trx_query

String

参数解释

额外信息,通常是正在执行的语句。

取值范围

不涉及。

trx_started

String

参数解释

事务开始时间。

取值范围

不涉及。

trx_rows_modified

Long

参数解释

事务修改的行数。

取值范围

≥0。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例 a23fb62bd61e4e9e9636fd2225f395bein07 所有回滚中事务的相关信息。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/nodes/18663926eacb443d98dc20f8620f28f2no07/txn-progress

{
  "action" : "rollback",
  "limit" : 10,
  "offset" : 0
}

响应示例

状态码:200

Success.

{
  "transactions" : [ {
    "trx_id" : "txn1",
    "estimated_remaining_time" : 120,
    "trx_mysql_thread_id" : 2075425,
    "trx_query" : "select sleep(1000)",
    "trx_started" : "2026-04-30T18:00:00Z",
    "trx_rows_modified" : 0
  }, {
    "trx_id" : "txn2",
    "estimated_remaining_time" : 0,
    "trx_mysql_thread_id" : 2075426,
    "trx_query" : "show processlist",
    "trx_started" : "2026-04-30T18:05:00Z",
    "trx_rows_modified" : 0
  } ],
  "total_count" : 2
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档