查询DTS任务步骤列表_数据传输服务(DTS)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListJobStep	系统规定参数。取值：ListJobStep。
DtsJobId	String	是	k2gm967v16f****	迁移或同步任务ID。
RegionId	String	否	cn-hangzhou	DTS实例所属的地域，详情请参见支持的地域列表。
ZeroEtlJob	Boolean	否	true	是否无感集成（Zero-ETL）任务，取值： true：是。 false：否。
ResourceGroupId	String	否	rg-aek3dcgyq7p****	资源组ID。

返回数据

名称	类型	示例值	描述
Success	Boolean	true	请求是否成功。
HttpStatusCode	Integer	200	状态码。
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	请求ID。
Code	String	200	错误码。
UseV2API	Boolean	True	是否使用Console2.0的API。
JobSteps	Array of JobStep		任务步骤信息。
JobStepId	String	l02c1f7h179****	任务步骤ID。
JobStepName	String	预检查	任务步骤信息。取值范围如下：预检查：预检查阶段增量数据服务：增量数据采集阶段 dts.step.struct.load：结构迁移阶段 dts.step.data.load：全量迁移阶段 etl-check：ETL阶段一致性校验：数据校验阶段同步：增量同步阶段
Code	String	01	任务步骤标识。
Serial	Integer	1	任务步骤系列号。任务执行顺序，数值越小执行顺序越靠前。
Progress	Integer	100	任务步骤进度
SubJobCount	Integer	1	子任务数。
IncLatencySeconds	Long	-1	增量数据延迟时间，单位为秒。
State	String	○ Finished	任务步骤状态。
ErrMsg	String	fullcheck find different records : 2372	报错信息。
SubJobSteps	Array of subJobStep		子任务的步骤信息。
JobStepId	String	mj3z9w9s10am68o_0004_0000	任务id。
JobStepName	String	test	子任务步骤信息。取值范围如下：预检查：预检查阶段增量数据服务：增量数据采集阶段 dts.step.struct.load：结构迁移阶段 dts.step.data.load：全量迁移阶段 etl-check：ETL阶段一致性校验：数据校验阶段同步：增量同步阶段
Code	String	03	子任务步骤标识。
Serial	Integer	123	子任务步骤系列号。任务执行顺序，数值越小执行顺序越靠前。
Progress	Integer	0	子任务步骤进度。
IncLatencySeconds	Long	1	增量数据延迟时间，单位为秒。
State	String	running	子任务步骤状态，取值范围： Failed：失败。 Pause：暂停。 Schedule：调度。 Init：初始化。 Running：同步中。 Catched：等待同步。 Finished：结束。
ErrMsg	String	UncaughtException:java.lang.NullPointerException	报错信息。
CreateTime	String	2024-09-20T02:13:12Z	子任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
BootTime	String	2025-01-02T02:00:21Z	子任务启动时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
FinishTime	String	2024-03-15T02:15:14Z	子任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ModifyTime	String	2024-08-22T02:04:35Z	子任务修改时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ErrorDetails	Array of ErrorDetail		错误信息。
ErrorCode	String	Success	错误码。
HelpUrl	String	****	帮助文档的URL。
IncLatencyMilliseconds	String	1	增量数据延迟时间，单位为毫秒。
NeedAcceleration	Boolean	true	判断是否需要提供尝试加速功能。
CreateTime	String	2023-11-28T17:13:51Z	任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
BootTime	String	2024-04-11T09:33:23Z	任务启动时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
FinishTime	String	2024-03-15T02:15:14Z	任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ModifyTime	String	2025-01-03T02:26:14Z	任务修改时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ErrorDetails	Array of ErrorDetail		错误信息。
ErrorCode	String	200	错误码。
HelpUrl	String	****	帮助文档的URL。
IncLatencyMilliseconds	Long	1	增量数据延迟时间，单位为毫秒。
NeedAcceleration	Boolean	true	判断是否需要提供尝试加速功能。
redisPhaseType	String	full	用于区分Redis全量和增量阶段。取值范围： full：全量阶段 inc：增量阶段

示例

请求示例

http(s)://[Endpoint]/?Action=ListJobStep
&DtsJobId=k2gm967v16f****
&RegionId=cn-hangzhou
&ZeroEtlJob=true
&ResourceGroupId=rg-aek3dcgyq7p****
&公共请求参数

正常返回示例

XML格式

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

<ListJobStepResponse>
    <Success>true</Success>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>621BB4F8-3016-4FAA-8D5A-5D3163CC****</RequestId>
    <Code>200</Code>
    <UseV2API>true</UseV2API>
    <JobSteps>
        <JobStepId>l02c1f7h179****</JobStepId>
        <JobStepName>预检查</JobStepName>
        <Code>01</Code>
        <Serial>1</Serial>
        <Progress>100</Progress>
        <SubJobCount>1</SubJobCount>
        <IncLatencySeconds>-1</IncLatencySeconds>
        <State>○ Finished</State>
        <ErrMsg>fullcheck find different records : 2372</ErrMsg>
        <SubJobSteps>
            <JobStepId>mj3z9w9s10am68o_0004_0000</JobStepId>
            <JobStepName>test</JobStepName>
            <Code>03</Code>
            <Serial>123</Serial>
            <Progress>0</Progress>
            <IncLatencySeconds>1</IncLatencySeconds>
            <State>running</State>
            <ErrMsg>UncaughtException:java.lang.NullPointerException</ErrMsg>
            <CreateTime>2024-09-20T02:13:12Z</CreateTime>
            <BootTime>2025-01-02T02:00:21Z</BootTime>
            <FinishTime>2024-03-15T02:15:14Z</FinishTime>
            <ModifyTime>2024-08-22T02:04:35Z</ModifyTime>
            <ErrorDetails>
                <ErrorCode>Success</ErrorCode>
                <HelpUrl>****</HelpUrl>
            </ErrorDetails>
            <IncLatencyMilliseconds>1</IncLatencyMilliseconds>
            <NeedAcceleration>true</NeedAcceleration>
        </SubJobSteps>
        <CreateTime>2023-11-28T17:13:51Z</CreateTime>
        <BootTime>2024-04-11T09:33:23Z</BootTime>
        <FinishTime>2024-03-15T02:15:14Z</FinishTime>
        <ModifyTime>2025-01-03T02:26:14Z</ModifyTime>
        <ErrorDetails>
            <ErrorCode>200</ErrorCode>
            <HelpUrl>****</HelpUrl>
        </ErrorDetails>
        <IncLatencyMilliseconds>1</IncLatencyMilliseconds>
        <NeedAcceleration>true</NeedAcceleration>
    </JobSteps>
</ListJobStepResponse>

JSON格式

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

{
  "Success" : true,
  "HttpStatusCode" : 200,
  "RequestId" : "621BB4F8-3016-4FAA-8D5A-5D3163CC****",
  "Code" : "200",
  "UseV2API" : true,
  "JobSteps" : [ {
    "JobStepId" : "l02c1f7h179****",
    "JobStepName" : "预检查",
    "Code" : "01",
    "Serial" : 1,
    "Progress" : 100,
    "SubJobCount" : 1,
    "IncLatencySeconds" : -1,
    "State" : "○ Finished",
    "ErrMsg" : "fullcheck find different records : 2372",
    "SubJobSteps" : [ {
      "JobStepId" : "mj3z9w9s10am68o_0004_0000",
      "JobStepName" : "test",
      "Code" : "03",
      "Serial" : 123,
      "Progress" : 0,
      "IncLatencySeconds" : 1,
      "State" : "running",
      "ErrMsg" : "UncaughtException:java.lang.NullPointerException",
      "CreateTime" : "2024-09-20T02:13:12Z",
      "BootTime" : "2025-01-02T02:00:21Z",
      "FinishTime" : "2024-03-15T02:15:14Z",
      "ModifyTime" : "2024-08-22T02:04:35Z",
      "ErrorDetails" : [ {
        "ErrorCode" : "Success",
        "HelpUrl" : "****"
      } ],
      "IncLatencyMilliseconds" : "1",
      "NeedAcceleration" : true
    } ],
    "CreateTime" : "2023-11-28T17:13:51Z",
    "BootTime" : "2024-04-11T09:33:23Z",
    "FinishTime" : "2024-03-15T02:15:14Z",
    "ModifyTime" : "2025-01-03T02:26:14Z",
    "ErrorDetails" : [ {
      "ErrorCode" : "200",
      "HelpUrl" : "****"
    } ],
    "IncLatencyMilliseconds" : 1,
    "NeedAcceleration" : true
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
400	Throttling.User	Request was denied due to user flow control.	由于请求频次达到阈值，请求被拒绝，请稍后重试。
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	签名已经过期，请更新签名
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。

访问错误中心查看更多错误码。