文档首页/ 云数据库 TaurusDB/ API参考/ API/ 无锁变更/ 查询无锁变更任务记录列表 - ListOnlineDDLTaskRecords
更新时间：2026-08-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询无锁变更任务记录列表 - ListOnlineDDLTaskRecords

功能介绍

查询无锁变更任务记录列表。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:database:list

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:list
    • gaussdb:database:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/operation-records

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

查询记录数。

约束限制：

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

取值范围：

1-100。

默认取值：

10。

offset

否

Integer

参数解释：

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

约束限制：

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

取值范围：

≥0。

默认取值：

0。

start_time

否

String

参数解释：

查询的起始时间戳，格式为UNIX时间戳，单位是毫秒，时区为UTC标准时区，

传参时需要将对应时区的时间转为标准时区对应的时间戳，比如，北京时区的时间点需要-8h后再转为时间戳。

约束限制：

不涉及。

取值范围：

只能由数字组成，长度为13个字符。

默认取值：

不涉及。

end_time

否

String

参数解释：

查询的结束时间戳，格式为UNIX时间戳，单位是毫秒，时区为UTC标准时区，

传参时需要将对应时区的时间转为标准时区对应的时间戳，比如，北京时区的时间点需要-8h后再转为时间戳。

约束限制：

不涉及。

取值范围：

只能由数字组成，长度为13个字符。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英文。

  • zh-cn：中文。

默认取值：

en-us。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

records

Array of RecordItem objects

参数解释：

无锁变更任务详情列表。

total_count

Integer

参数解释：

无锁变更任务记录总数，整数。

取值范围：

≥0。
表5 RecordItem

参数

参数类型

描述

task_id

String

参数解释：

无锁变更任务记录标识。

取值范围：

不涉及。

task_content

Array of TaskContentItem objects

参数解释：

无锁变更任务详细内容。

created_at

Integer

参数解释：

无锁变更任务创建时间，13位毫秒时间戳。

取值范围：

不涉及。

ended_at

Integer

参数解释：

无锁变更任务结束时间，13位毫秒时间戳。

取值范围：

不涉及。

task_status

String

参数解释：

无锁变更任务执行状态。

取值范围：

  • checking：表示正在执行预检查步骤。

  • check successful： 表示预检查步骤执行成功。

  • check failed： 表示预检查步骤执行失败。

  • altering： 表示正在任务正在执行变更步骤。

  • alter successful： 表示变更步骤执行成功。

  • alter failed： 表示变更步骤执行失败。

  • stopping：表示正在执行停止任务步骤。

  • stop successful： 表示执行停止步骤成功。

  • stop failed： 表示执行停止步骤失败。

  • cleaning： 表示正在执行清理临时表步骤。

  • clean successful： 表示清理临时表步骤执行成功。

  • clean failed： 表示清理临时表步骤执行失败。

alter_stage

Integer

参数解释：

表示数据库内核层面无锁变更任务运行阶段。

取值范围：

  • 0：表示无锁变更任务未开始。

  • 1：表示无锁变更任务已完成资源初始化。

  • 2：表示无锁变更任务正在运行。

  • 3：表示无锁变更任务已完成。

percentage

Float

参数解释：

无锁变更任务百分比进度，1位小数精度。

取值范围：

0.0-100.0。

error_reason

String

参数解释：

无锁变更任务失败原因，任务执行失败时有返回值。

取值范围：

不涉及。

temp_table_name

String

参数解释：

无锁变更任务临时表名称，关闭临时表自动清理时有返回值。

取值范围：

不涉及。
表6 TaskContentItem

参数

参数类型

描述

schema

String

参数解释：

无锁变更的目标数据库。

取值范围：

不涉及。

ddl_info

Array of DDLInfoItem objects

参数解释：

无锁变更的DDL信息。
表7 DDLInfoItem

参数

参数类型

描述

table

String

参数解释：

无锁变更的目标表。

取值范围：

不涉及。

sql

String

参数解释：

无锁变更的具体执行SQL。

取值范围：

不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询录实例任务无锁变更任务记录。

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/operation-records?offset=0&limit=10&start_time=1774972800000&end_time=1775750399000

响应示例

状态码：200

Success.

{
  "records" : [ {
    "task_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b",
    "task_content" : [ {
      "schema" : "testdb",
      "ddl_info" : [ {
        "table" : "test_tb",
        "sql" : "Alter table test_tb add name varchar(11)"
      } ]
    } ],
    "created_at" : 1743563656172,
    "ended_at" : 1743563683552,
    "task_status" : "alter successful",
    "alter_stage" : 3,
    "percentage" : 100,
    "error_reason" : "XXX",
    "temp_table_name" : "~test_tb_20250402111436_del"
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 无锁变更

相关文档