Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Workload Replay/ Querying the Workload Replay Progress (ShowReplayProgress)
Updated on 2026-03-17 GMT+08:00
View PDF
Share

Querying the Workload Replay Progress (ShowReplayProgress)

Function

This API is used to query the progress of a workload replay task.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs/{job_id}/replay-progress

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the IAM API for obtaining a user token. After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

progress

Long

Replay progress percentage.

parse_count

Long

Total number of records to be parsed.

replay_count

Long

Total number of replay records.

task_mode

String

Migration mode.

process_time

Long

Migration time.

transfer_status

String

Migration status.

max_time

Long

Maximum replay time.

min_time

Long

Minimum replay time.

now_time

Long

Current replay time.

min_export_time

Long

Minimum time for replaying a report.

max_export_time

Long

Maximum time for replaying a report.

replay_sql_now_list

Array of ReplaySqlNowInfo objects

List of SQL statements being replayed.
Table 4 ReplaySqlNowInfo

Parameter

Type

Description

thread_id

Long

Session ID.

created_at

Long

Creation time.

modified_at

Long

Modification time.

shard_id

Long

Shard ID.

schema_name

String

Schema name.

sql_statement

String

SQL statement.

latency

Long

Original duration.

execute_latency

Long

Execution duration.

target_type

String

Destination database type.

target_name

String

Destination database ID.

status

String

Replay status. The value can be: - running: The replay is being executed. - finish: The replay is complete.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Querying the progress of a replay task

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-progress

Example Responses

Status code: 200

OK

{
  "progress" : 0,
  "task_mode" : "FULL_INCR_TRANS",
  "transfer_status" : "REPLAY_FINISH",
  "process_time" : 1763017610325,
  "replay_count" : 55956,
  "min_time" : 1763447845000,
  "max_time" : 1763499928000,
  "now_time" : 1763499928000,
  "replay_sql_now_list" : [ ],
  "min_export_time" : 1763625851000,
  "max_export_time" : 1763626722000,
  "parse_count" : 55956,
  "remaining_time" : 0
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10020000",
  "error_msg" : "Incorrect parameter type."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Workload Replay