ListDIJobs - DataWorks - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ListDIJobs	The operation that you want to perform. Set the value to ListDIJobs.
ProjectId	Long	Yes	1967	The workspace ID.
JobName	String	No	mysql_to_holo_sync_8772	The name of the task. Fuzzy match is supported. If you do not configure this parameter, no limits are imposed on the tasks.
SourceDataSourceType	String	No	MySQL	The source type. If you do not configure this parameter, no limits are imposed on the tasks.
DestinationDataSourceType	String	No	Hologres	The destination type. If you do not configure this parameter, no limits are imposed on the tasks.
PageNumber	Integer	No	1	The page number. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Default value: 10. Maximum value: 100.

Response parameters

Parameter	Type	Example	Description
RequestId	String	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41	The request ID.
DIJobPaging	Object		The pagination data.
TotalCount	Integer	6	The total number of entries returned.
PageNumber	Integer	1	The page number.
PageSize	Integer	10	The number of entries per page.
DIJobs	Array of DIJob		The tasks.
DIJobId	Long	16626	The task ID.
ProjectId	Long	1967	The workspace ID.
JobName	String	mysql_to_holo_sync_8772	The task name.
MigrationType	String	Full	The synchronization type.
SourceDataSourceType	String	MySQL	The source type.
DestinationDataSourceType	String	Hologres	The destination type.
JobStatus	String	Finished	The task status.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDIJobs
&ProjectId=1967
&JobName=mysql_to_holo_sync_8772
&SourceDataSourceType=MySQL
&DestinationDataSourceType=Hologres
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDIJobsResponse>
    <RequestId>7263E4AC-9D2E-5B29-B8AF-7C5012E92A41</RequestId>
    <DIJobPaging>
        <TotalCount>6</TotalCount>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <DIJobs>
            <DIJobId>16626</DIJobId>
            <ProjectId>1967</ProjectId>
            <JobName>mysql_to_holo_sync_8772</JobName>
            <MigrationType>Full</MigrationType>
            <SourceDataSourceType>MySQL</SourceDataSourceType>
            <DestinationDataSourceType>Hologres</DestinationDataSourceType>
            <JobStatus>Finished</JobStatus>
        </DIJobs>
    </DIJobPaging>
</ListDIJobsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
429	Throttling.Api	The request for this resource has exceeded your available limit.	The number of requests for the resource has exceeded the upper limit.
429	Throttling.System	The DataWorks system is busy. Try again later.	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	Excessive requests have been submitted within a short period of time. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.	An internal error has occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error has occurred. Try again later.

For a list of error codes, see Service error codes.