ListDIJobs API Reference for Data Integration Jobs - DataWorks

Lists Data Integration jobs.

Operation description

This operation requires DataWorks Basic Edition or a later edition.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages are numbered starting from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default: 10. Maximum: 100.	10
Name	string	No	The name of the Data Integration job. The name must be unique within the DataWorks workspace.	test_export_01
SourceDataSourceType	string	No	The type of the source data source. If you do not specify this parameter, jobs are not filtered by this criterion. Valid values: `PolarDB`, `MySQL`, `Kafka`, `LogHub`, `Hologres`, `Oracle`, `OceanBase`, `MongoDB`, `RedShift`, `Hive`, `SQLServer`, `Doris`, and `ClickHouse`.	MySQL
DestinationDataSourceType	string	No	The type of the destination data source. If you do not specify this parameter, jobs are not filtered by this criterion. Valid values: `Hologres`, `OSS-HDFS`, `OSS`, `MaxCompute`, `LogHub`, `StarRocks`, `DataHub`, `AnalyticDB_For_MySQL`, `Kafka`, and `Hive`.	Hologres
MigrationType	string	No	The synchronization type. Valid values: `FullAndRealtimeIncremental`: full and real-time incremental synchronization `RealtimeIncremental`: real-time incremental synchronization `Full`: full synchronization `OfflineIncremental`: offline incremental synchronization `FullAndOfflineIncremental`: full and offline incremental synchronization	FullAndRealtimeIncremental
ProjectId	integer	Yes	The ID of the DataWorks workspace.	1967
SpecType	string	No	The configuration type of the job. Valid values: `FILESPEC`, `CLASSIC`, and `ALL`. `FILESPEC` indicates a new job type configured based on a structured file specification. `CLASSIC` indicates a job configured in the traditional mode. If you set this parameter to `ALL`, jobs of both types are returned.

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
PagingInfo	object	The paging information.
TotalCount	integer	The total number of entries that meet the filter criteria.	12
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The returned page number.	1
DIJobs	array<object>	A list of Data Integration jobs.
	object	Details of a Data Integration job.
Id	integer	The ID of the Data Integration job.	32599
ProjectId	integer	The ID of the DataWorks workspace that contains the job.	26442
JobName	string	The name of the job.	mysql_to_holo_sync_35197
MigrationType	string	The synchronization type. Valid values: `FullAndRealtimeIncremental`: full and real-time incremental synchronization `RealtimeIncremental`: real-time incremental synchronization `Full`: full synchronization `OfflineIncremental`: offline incremental synchronization `FullAndOfflineIncremental`: full and offline incremental synchronization	FullAndRealtimeIncremental
SourceDataSourceType	string	The type of the source data source. Valid values: `PolarDB`, `MySQL`, `Kafka`, `LogHub`, `Hologres`, `Oracle`, `OceanBase`, `MongoDB`, `RedShift`, `Hive`, `SQLServer`, `Doris`, and `ClickHouse`.	Mysql
DestinationDataSourceType	string	The type of the destination data source. Valid values: `Hologres`, `OSS-HDFS`, `OSS`, `MaxCompute`, `LogHub`, `StarRocks`, `DataHub`, `AnalyticDB_For_MySQL`, `Kafka`, and `Hive`.	Hologres
JobStatus	string	The job status. Valid values: `Finished`: The job completed successfully. `Initialized`: The job is initialized. `Stopped`: The job is stopped. `Failed`: The job failed. `Running`: The job is running. `Stopping`: The job is being stopped.	Running
DIJobId `deprecated`	integer	This parameter is deprecated. Use the `Id` parameter instead.	32599
Owner	string

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.