GetOnlineDDLProgress - 获取OnlineDDL任务执行进度详情

调用GetOnlineDDLProgress接口,获取OnlineDDL任务执行进度详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetOnlineDDLProgressget
*全部资源
*

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***
JobDetailIdlong

OnlineDDL SQL 任务详情 ID。您可通过调用 ListDBTaskSQLJobDetail 接口获取该参数的值。

15***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Successboolean

请求是否成功。返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

403
OnlineDDLTaskDetailobject

任务详细信息。

JobStatusstring

任务状态。返回值如下:

  • INIT:初始化。
  • SUCCESS:已完成。
  • RUNNING:执行中。
  • WAITING_CUTOVER:等待 cut-over。
  • RESTARTING:重启中。
  • PAUSE:暂停中。
  • UNSUPPORTED:不支持。
  • CANCELED:已取消。
  • FAIL:已失败。
  • INTERRUPT:已中断。
SUCCESS
StatusDescstring

任务状态描述信息。

Success
DelaySecondslong

DMS 回放延迟,即回放原表的 Binlog 到临时表的延迟时间(单位:秒),与数据库的主备无关。

0
CopyTotallong

预估的数据总行数,取自 information_schema 库的统计数据,通常比表中的真实数据量小。

10
CopyCountlong

DMS 无锁变更实际拷贝的原表数据量。

9
ProgressRatiostring

预估的执行进度。具体以任务状态为准。

90%
CutoverLockTimeSecondslong

切换表时,锁表超时时间。

2
CutoverFailRetryTimeslong

切换表失败时重试次数。

3
CleanStrategystring

完成切换表操作后,原表的清理策略,返回值如下:

  • DROP:系统自动删除无效原表。
  • MOVE:将无效原表移动到 test 数据库,再进行手动清理。
  • NOTHING:原库中保留无效原表,再进行手动清理。
DROP
CopyChunkSizelong

全量拷贝大小。该参数用于指定每个小块的大小。单次拷贝块越大,全量拷贝时间越短,但同时对业务影响越大。

说明 在全量拷贝阶段,将原表分为 N 个小块逐个拷贝到临时表,DMS 缺省动态调整每个块的大小。
1000
CopyChunkModestring

全量拷贝策略,返回值如下:

  • AUTO:DMS 根据数据库的性能动态调整,单次拷贝锁表时间控制在 1.5 秒以内。
  • RUNNING:DMS 根据您指定的 CopyChunkSize 大小(1-60000)拷贝原表数据,此模式下必须设置 CopyChunkSize。
AUTO
CutoverWindowStartTimestring

切换表的时间窗口开始时间。默认为 00:00:00。该参数可以控制切换表的时间窗口,指定当满足切换表条件且在时间窗口以内时才可以切换,未在窗口内时则一直等待窗口。

12:00:00
CutoverWindowEndTimestring

切换表的时间窗口结束时间,与 CutoverWindowStartTime 至少间隔 30 分钟。默认为 23:59:59。

13:00:00

示例

正常返回示例

JSON格式

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "403",
  "OnlineDDLTaskDetail": {
    "JobStatus": "SUCCESS",
    "StatusDesc": "Success",
    "DelaySeconds": 0,
    "CopyTotal": 10,
    "CopyCount": 9,
    "ProgressRatio": "90%",
    "CutoverLockTimeSeconds": 2,
    "CutoverFailRetryTimes": 3,
    "CleanStrategy": "DROP",
    "CopyChunkSize": 1000,
    "CopyChunkMode": "AUTO",
    "CutoverWindowStartTime": "12:00:00",
    "CutoverWindowEndTime": "13:00:00"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史