Help Center> Data Replication Service> API Reference> APIs V5.0 (in OBT)> Comparison Management> Querying the Data-Level Streaming Comparison List
Updated on 2024-01-30 GMT+08:00
Online Debugging
CLI Examples
View PDF

Querying the Data-Level Streaming Comparison List

Function

This API is used to query the migration progress of different migration tasks. Note:

  • Before the task is completed, do not modify the information about all source and destination database users, passwords, and permissions.
  • If the status indicates a full or incremental migration is complete, there may still be triggers or events to be migrated before the entire task is finished.

Constraints

This API can be used only in certain regions. For details, see Endpoints.

URI

GET /v5/{project_id}/jobs/{job_id}/progress-data/{type}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

type

Yes

String

Migration object type.

  • table
  • event
  • table_structure
  • procedure
  • view
  • function
  • database
  • trigger
  • table_indexs
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.

Minimum value: 1

Maximum value: 1000

Default value: 10

offset

No

String

Offset, which is the position where the query starts. The value must be greater than or equal to 0. The default value is 0.

Default value: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

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.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

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.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Long

Total number.

create_time

String

Data generation time.

flow_compare_data

Array of objects

Comparison result.

For details, see Table 5.
Table 5 flow_compare_data parameters

Parameter

Type

Description

src_db

String

Source database name.

src_tb

String

Source object name.

dst_db

String

Destination database name.

dst_tb

String

Destination object name.

progress

Integer

Progress.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Querying the data-level streaming comparison list

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/progress-data/table?offset=1&limit=10

Example Response

Status code: 200

OK 
{
  "count": 1,
  "create_time": "1686038576882",
  "flow_compare_data": [
    {
      "src_db": "a",
      "src_tb": "b",
      "dst_db": "c",
      "dst_tb": "d",
      "progress": 10
    }
  ]
}

Status code: 400

Bad Request

{
  "error_code": "DRS.M05003",
  "error_msg": "Task information not found."
}

Error Code

For details, see Error Code.

Parent topic: Comparison Management