ListDIJobs - DataWorks - Alibaba Cloud Documentation Center

Queries a list of new-version synchronization tasks. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.

Operation description

You can call this operation to obtain only the basic information about the tasks. If you want to obtain the details of a task, call the GetDIJob operation.

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
ProjectId	long	Yes	The ID of the workspace.	1967
JobName	string	No	The name of the task. Fuzzy match is supported. If you do not configure this parameter, no limits are imposed on the tasks.	mysql_to_holo_sync_8772
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
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
DIJobPaging	object	The pagination information.
TotalCount	integer	The total number of entries returned.	6
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
DIJobs	array<object>	The list of tasks.
DIJob	object
DIJobId	long	The task ID.	16626
ProjectId	long	The workspace ID.	1967
JobName	string	The task name.	mysql_to_holo_sync_8772
MigrationType	string	The synchronization type. Valid values: FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization RealtimeIncremental: real-time incremental synchronization Full: one-time full synchronization	Full
SourceDataSourceType	string	The type of the source. The value MySQL is returned.	MySQL
DestinationDataSourceType	string	The type of the destination. The value Hologres is returned.	Hologres
JobStatus	string	The task status. Valid values: Finished Initialized Stopped Failed Running Stopping	Finished

Examples

Sample success responses

JSONformat

{
  "RequestId": "7263E4AC-9D2E-5B29-B8AF-7C5012E92A41",
  "DIJobPaging": {
    "TotalCount": 6,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobs": [
      {
        "DIJobId": 16626,
        "ProjectId": 1967,
        "JobName": "mysql_to_holo_sync_8772",
        "MigrationType": "Full",
        "SourceDataSourceType": "MySQL",
        "DestinationDataSourceType": "Hologres",
        "JobStatus": "Finished"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

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

Change history

Change time	Summary of changes	Operation

No change history