GetOnlineDDLProgress - Query OnlineDDL task progress - Data Management

Queries the details and progress of an OnlineDDL task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetOnlineDDLProgress

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the DMS console (Manage DMS tenants).	3***
JobDetailId	integer	Yes	The OnlineDDL SQL task detail ID. Call ListDBTaskSQLJobDetail to obtain this ID.	15***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Success	boolean	Whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message if the request failed.	UnknownError
ErrorCode	string	The error code if the request failed.	403
OnlineDDLTaskDetail	object	The details of the task.
JobStatus	string	The task status. Valid values: INIT: Initializing. SUCCESS: Completed. RUNNING: Running. WAITING_CUTOVER: Waiting for cut-over. RESTARTING: Restarting. PAUSE: Suspended. UNSUPPORTED: Not supported. CANCELED: Canceled. FAIL: Failed. INTERRUPT: Interrupted.	SUCCESS
StatusDesc	string	The task status description.	Success
DelaySeconds	integer	The DMS binary log replay latency, in seconds. This measures the time to replay binary logs from the original table to the temporary table, not the replication latency between primary and secondary databases.	0
CopyTotal	integer	The estimated total row count, from information_schema statistics. This estimate is typically smaller than the actual row count.	10
CopyCount	integer	The number of rows copied from the original table during the lock-free change.	9
ProgressRatio	string	The estimated progress. Actual progress depends on the task status.	90%
CutoverLockTimeSeconds	integer	Maximum table lock duration during cut-over, in seconds.	2
CutoverFailRetryTimes	integer	Number of retries on cut-over failure.	3
CleanStrategy	string	Cleanup policy for the original table after cut-over. Valid values: DROP: Drops the original table. MOVE: Moves the original table to the test database for manual cleanup. NOTHING: Retains the original table in the database for manual cleanup.	DROP
CopyChunkSize	integer	The chunk size for data replication. Larger chunks improve replication speed but may affect business performance. Note During full replication, the original table is split into chunks that are copied to the temporary table sequentially. DMS dynamically adjusts chunk size by default.	1000
CopyChunkMode	string	The full replication mode. Valid values: AUTO: DMS dynamically adjusts chunk size. Tables are locked for less than 1.5 seconds per replication operation. RUNNING: Uses the specified CopyChunkSize value (1 to 60000). Required when this mode is selected.	AUTO
CutoverWindowStartTime	string	Start of the cut-over time window. Default value: 00:00:00. Cut-over runs only when conditions are met and the current time falls within this window.	12:00:00
CutoverWindowEndTime	string	End of the cut-over time window. Must be at least 30 minutes after CutoverWindowStartTime. Default value: 23:59:59.	13:00:00

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.