All Products
Search
Document Center

DataWorks:ListDIJobs

Last Updated:Nov 21, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*list
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the workspace.

1967
JobNamestringNo

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
SourceDataSourceTypestringNo

The source type. If you do not configure this parameter, no limits are imposed on the tasks.

MySQL
DestinationDataSourceTypestringNo

The destination type. If you do not configure this parameter, no limits are imposed on the tasks.

Hologres
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

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

10

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
DIJobPagingobject

The pagination information.

TotalCountinteger

The total number of entries returned.

6
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
DIJobsarray<object>

The list of tasks.

DIJobobject
DIJobIdlong

The task ID.

16626
ProjectIdlong

The workspace ID.

1967
JobNamestring

The task name.

mysql_to_holo_sync_8772
MigrationTypestring

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
SourceDataSourceTypestring

The type of the source. The value MySQL is returned.

MySQL
DestinationDataSourceTypestring

The type of the destination. The value Hologres is returned.

Hologres
JobStatusstring

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 codeError codeError messageDescription
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

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

Change history

Change timeSummary of changesOperation
No change history