ListDIJobs - DataWorks - Alibaba Cloud Documentation Center

Queries a list of synchronization tasks.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
Name	string	No	The name of the export task. The name of each export task must be unique. You must make sure that the names of the export tasks in the current workspace are unique.	test_export_01
SourceDataSourceType	string	No	The source type. If you do not configure this parameter, no limits are imposed on the tasks.	MySQL
DestinationDataSourceType	string	No	The destination type. If you do not configure this parameter, no limits are imposed on the tasks.	Hologres
MigrationType	string	No	The synchronization type. Valid values: FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization RealtimeIncremental: real-time incremental synchronization Full: full synchronization OfflineIncremental: batch incremental synchronization FullAndOfflineIncremental: one-time full synchronization and batch incremental synchronization	FullAndRealtimeIncremental
ProjectId	long	Yes	The DataWorks workspace ID.	1967

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
PagingInfo	object	The pagination information.
TotalCount	long	The total number of entries returned.	12
PageSize	long	The number of entries per page.	10
PageNumber	long	The page number.	1
DIJobs	array<object>	The synchronization tasks returned.
DIJobs	object	The synchronization task.
DIJobId	long	The ID of the synchronization task.	32599
ProjectId	long	The ID of the DataWorks workspace to which the synchronization task belongs.	26442
JobName	string	The name of the synchronization task.	mysql_to_holo_sync_35197
MigrationType	string	The synchronization type. Valid values: FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization RealtimeIncremental: real-time incremental synchronization Full: full synchronization OfflineIncremental: batch incremental synchronization FullAndOfflineIncremental: one-time full synchronization and batch incremental synchronization	FullAndRealtimeIncremental
SourceDataSourceType	string	The source type. The value MySQL is returned.	Mysql
DestinationDataSourceType	string	The destination type. Valid values: Hologres and Hive.	Hologres
JobStatus	string	The status of the synchronization task. Valid values: Finished Initialized Stopped Failed Running Stopping	Running

Examples

Sample success responses

JSONformat

{
  "RequestId": "7263E4AC-9D2E-5B29-B8AF-7C5012E92A41",
  "PagingInfo": {
    "TotalCount": 12,
    "PageSize": 10,
    "PageNumber": 1,
    "DIJobs": [
      {
        "DIJobId": 32599,
        "ProjectId": 26442,
        "JobName": "mysql_to_holo_sync_35197",
        "MigrationType": "FullAndRealtimeIncremental",
        "SourceDataSourceType": "Mysql",
        "DestinationDataSourceType": "Hologres",
        "JobStatus": "Running"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history