All Products
Search
Document Center

DataWorks:ListDIJobRunDetails

Last Updated:Dec 10, 2024

Queries the running information about a synchronization task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DIJobIdlongYes

The ID of the synchronization task.

11265
InstanceIdlongNo

The instance ID.

1234
PageNumberlongNo

The page number.

1
PageSizelongNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
SourceDataSourceNamestringNo

The name of the source.

ds_name
SourceDatabaseNamestringNo

The name of the database in the source.

db_name
SourceSchemaNamestringNo

The name of the schema of the source.

schema_name
SourceTableNamestringNo

The name of the table in the source.

table_name

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

691CA452-D37A-4ED0-9441
PagingInfoobject

The pagination information.

TotalCountstring

The total number of entries returned.

131
PageSizestring

The number of entries per page.

10
PageNumberstring

The page number.

1
JobRunInfosarray<object>

The running information about the synchronization task.

JobRunInfosobject

The running information about the synchronization task for a single table.

SourceDatasourceNamestring

The name of the source.

ds_name
SourceDatabaseNamestring

The name of the database in the source.

db_name
SourceSchemaNamestring

The name of the schema of the source.

schema_name
SourceTableNamestring

The name of the table in the source.

table_name
DestinationDatasourceNamestring

The name of the destination.

dst_name
DestinationDatabaseNamestring

The name of the database in the destination.

dst_db
DestinationSchemaNamestring

The name of the schema of the destination.

dst_schema
DestinationTableNamestring

The name of the table in the destination.

dst_name
StructureMigrationStatusstring

The synchronization status of the schema.

Finished
StructureMigrationErrorMessagestring

The error message that is returned if an error occurs during schema synchronization. If no error occurs, no value is returned for this parameter.

create table t1 fail.
FullMigrationStatusstring

The status of full batch synchronization.

Finished
FullMigrationErrorMessagestring

The error message that is returned if an error occurs during full batch synchronization. If no error occurs, no value is returned for this parameter.

sync table t1 fail.
OfflineErrorRecordslong

The total number of errors that occur during full synchronization.

0
OfflineTotalByteslong

The total number of bytes that are synchronized during full synchronization.

100
OfflineTotalRecordslong

The total number of data records that are synchronized during full synchronization.

10
RealtimeMigrationStatusstring

The status of real-time synchronization.

Running
RealtimeMigrationErrorMessagestring

The error message that is returned if an error occurs during real-time synchronization. If no error occurs, no value is returned for this parameter.

sync table t1 fail.

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history