Call ListDIJobs to query synchronization tasks - DataWorks - Alibaba Cloud - DataWorks

Queries the list of new-version data integration tasks. Currently supported task types include MySQL-to-Hologres full-database real-time synchronization tasks.

Operation description

This list operation returns only basic task information. To view detailed task information, call the GetDIJob operation.

Prerequisites: Activate DataWorks Enterprise Edition or Ultimate Edition first. The required ProjectId can be obtained from PageResult.ProjectList[].ProjectId in the ListProjects response. If the required edition is not activated, this operation returns 403 Forbidden.Access.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The workspace ID.	1967
JobName	string	No	The task name. If this parameter is not specified, no filtering is applied. Fuzzy match is supported.	mysql_to_holo_sync_8772
SourceDataSourceType	string	No	The source data source type. If this parameter is not specified, no filtering is applied.	MySQL
DestinationDataSourceType	string	No	The destination data source type. If this parameter is not specified, no filtering is applied.	Hologres
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The page size. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
DIJobPaging	object	The paginated task results.
TotalCount	integer	The total number of records.	6
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
DIJobs	array<object>	The task list.
	object	The task.
DIJobId	integer	The task ID.	16626
ProjectId	integer	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 Valid values: FullAndRealtimeIncremental : RealtimeIncremental : Full :	Full
SourceDataSourceType	string	The type of the source. The value MySQL is returned. Valid values: MySQL : MySQL	MySQL
DestinationDataSourceType	string	The type of the destination. The value Hologres is returned. Valid values: Hologres : Hologres	Hologres
JobStatus	string	The task status. Valid values: Finished Initialized Stopped Failed Running Stopping Valid values: Finished : Initialized : Stopped : Failed : Running : Stopping :	Finished

Examples

Success response

JSON format

{
  "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
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.