Queries the details of extract, transform, and load (ETL) tasks.

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 DescribeDtsEtlJobVersionInfo

The operation that you want to perform. Set the value to DescribeDtsEtlJobVersionInfo.

PageSize Integer No 20

The number of entries to return on each page. Default value: 20.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

DtsInstanceId String Yes dtsggk12iwya1a****

The ID of the Data Transmission Service (DTS) instance. You can call the DescribeDtsJobs operation to query the instance ID.

DtsJobId String No l5512es7w15****

The ID of the ETL task. You can call the DescribeDtsJobs operation to query the task ID.

RegionId String No cn-hangzhou

The ID of the region in which the DTS instance resides. You can call the DescribeRegions operation to query the available Alibaba Cloud regions.

Response parameters

Parameter Type Example Description
RequestId String 224DB9F7-3100-4899-AB9C-C938BCCB43E7

The ID of the request.

Success Boolean true

Indicates whether the call was successful. If the call failed, false is returned.

ErrCode String InvalidJobId

The error code. This example indicates that the specified ETL task ID is invalid.

PageNumber Integer 1

The page number of the returned page. Default value: 1.

PageRecordCount Integer 20

The number of records returned on the current page.

TotalRecordCount Integer 200

The total number of records.

ErrMessage String The specified dts job id %s is not exists.

The error message. This example indicates that the specified ETL task ID does not exist. In this case, the ETL task may have been deleted.

HttpStatusCode String 200

The HTTP status code.

DynamicCode String 403

The dynamic error code.

DynamicMessage String present environment is not support,so skip

The dynamic part in the error message.

DtsEtlJobVersionInfos Array of DtsEtlJobVersionInfo

The details of ETL tasks.

Status String INFO

The log level. Valid values: ERROR, WARN, INFO, and DEBUG.

DtsJobName String test_sql

The name of the ETL task.

DtsJobId String l5512es7w15****

The ID of the ETL task.

Version Integer 9

The version number of the ETL task.

DtsInstanceId String dtsg******gd

The ID of the DTS instance.

CreateTime String 1637229315000

The time when the ETL task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

SafeCheckpoint String 1637230117000

The safe checkpoint of the ETL task.

Creator String 10000000

The ID of the creator.

ModifyTime String 1637230117000

The time when the ETL task was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

CreatorName String ***@****.com

The username of the creator.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeDtsEtlJobVersionInfo
&pageSize=20
&pageNumber=0
&dtsInstanceId=dtsggk12iwya1a****
&DtsJobId=l5512es7w15****
&RegionId=cn-hangzhou
&<Required parameters>
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDtsEtlJobVersionInfoResponse>
<requestId>62E37CD4-586B-50A4-99AA-3E60D2485F6C</requestId>
<success>true</success>
<dtsEtlJobVersionInfos>
    <createTime>1637229315000</createTime>
    <creator>10000000</creator>
    <creatorName>***@****.com</creatorName>
    <dtsInstanceId>dtsggk12iwya1a****</dtsInstanceId>
    <dtsJobId>l5512es7w15****</dtsJobId>
    <dtsJobName>test_sql</dtsJobName>
    <modifyTime>1637230117000</modifyTime>
    <status>INFO</status>
    <version>9</version>
</dtsEtlJobVersionInfos>
<httpStatusCode>200</httpStatusCode>
</DescribeDtsEtlJobVersionInfoResponse>

JSON format

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

{
  "requestId" : "62E37CD4-586B-50A4-99AA-3E60D2485F6C",
  "success" : true,
  "dtsEtlJobVersionInfos" : [ {
    "createTime" : 1637229315000,
    "creator" : "10000000",
    "creatorName" : "***@****.com",
    "dtsInstanceId" : "dtsggk12iwya1a****",
    "dtsJobId" : "l5512es7w15****",
    "dtsJobName" : "test_sql",
    "modifyTime" : 1637230117000,
    "status" : "INFO",
    "version" : 9
  } ],
  "httpStatusCode" : 200
}

Error codes

HTTP status code Error code Error message Description
400 Throttling.User Request was denied due to user flow control. The error message returned because the number of requests exceeds the limit and the request is rejected. Try again later.
500 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. The error message returned because the signature expired. Use a new signature.

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