Queries the run details of a data integration synchronization task, including per-table progress and error information.
Operation description
This API operation is available for all DataWorks editions.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DIJobId |
integer |
Yes |
The ID of the synchronization task. |
11265 |
| InstanceId |
integer |
No |
The instance ID. |
1234 |
| PageNumber |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| SourceDataSourceName |
string |
No |
The name of the source data source. |
ds_name |
| SourceDatabaseName |
string |
No |
The name of the database in the source. |
db_name |
| SourceSchemaName |
string |
No |
The name of the schema of the source. |
schema_name |
| SourceTableName |
string |
No |
The name of the table in the source. |
table_name |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. You can use the ID to query logs and troubleshoot issues. |
691CA452-D37A-4ED0-9441 |
| PagingInfo |
object |
The pagination information. |
|
| TotalCount |
string |
The total number of entries returned. |
131 |
| PageSize |
string |
The number of entries per page. |
10 |
| PageNumber |
string |
The page number. |
1 |
| JobRunInfos |
array<object> |
The run details of the synchronization task. |
|
|
object |
The run details of the synchronization task for a single table. |
||
| SourceDatasourceName |
string |
The name of the source data source. |
ds_name |
| SourceDatabaseName |
string |
The name of the database in the source. |
db_name |
| SourceSchemaName |
string |
The name of the schema of the source. |
schema_name |
| SourceTableName |
string |
The name of the table in the source. |
table_name |
| DestinationDatasourceName |
string |
The name of the destination data source. |
dst_name |
| DestinationDatabaseName |
string |
The name of the database in the destination. |
dst_db |
| DestinationSchemaName |
string |
The name of the schema of the destination. |
dst_schema |
| DestinationTableName |
string |
The name of the table in the destination. |
dst_name |
| StructureMigrationStatus |
string |
The synchronization status of the schema. |
Finished |
| StructureMigrationErrorMessage |
string |
The error message returned if schema synchronization fails. No value is returned if no error occurs. |
create table t1 fail. |
| FullMigrationStatus |
string |
The status of full batch synchronization. |
Finished |
| FullMigrationErrorMessage |
string |
The error message returned if full batch synchronization fails. No value is returned if no error occurs. |
sync table t1 fail. |
| OfflineErrorRecords |
integer |
The total number of error records during full synchronization. |
0 |
| OfflineTotalBytes |
integer |
The total number of bytes synchronized during full synchronization. |
100 |
| OfflineTotalRecords |
integer |
The total number of records synchronized during full synchronization. |
10 |
| RealtimeMigrationStatus |
string |
The status of real-time synchronization. |
Running |
| RealtimeMigrationErrorMessage |
string |
The error message returned if real-time synchronization fails. No value is returned if no error occurs. |
sync table t1 fail. |
Examples
Success response
JSON format
{
"RequestId": "691CA452-D37A-4ED0-9441",
"PagingInfo": {
"TotalCount": "131",
"PageSize": "10",
"PageNumber": "1",
"JobRunInfos": [
{
"SourceDatasourceName": "ds_name",
"SourceDatabaseName": "db_name",
"SourceSchemaName": "schema_name",
"SourceTableName": "table_name",
"DestinationDatasourceName": "dst_name",
"DestinationDatabaseName": "dst_db",
"DestinationSchemaName": "dst_schema",
"DestinationTableName": "dst_name",
"StructureMigrationStatus": "Finished",
"StructureMigrationErrorMessage": "create table t1 fail.",
"FullMigrationStatus": "Finished",
"FullMigrationErrorMessage": "sync table t1 fail.",
"OfflineErrorRecords": 0,
"OfflineTotalBytes": 100,
"OfflineTotalRecords": 10,
"RealtimeMigrationStatus": "Running",
"RealtimeMigrationErrorMessage": "sync table t1 fail.\n"
}
]
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.