调用ListDBTaskSQLJobDetail获取SQL任务详情列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDBTaskSQLJobDetail

系统规定参数。取值:ListDBTaskSQLJobDetail

JobId Long 1276****

SQL任务ID,可通过调用接口ListDBTaskSQLJob获取该参数的值。

PageNumber Long 1

开始页码。

PageSize Long 20

每页数据量。

Tid Long 3***

租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。

RegionId String cn-hangzhou

DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
RequestId String 3F044E33-FE09-58F1-8C61-A0F612EC****

请求ID。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
ErrorMessage String JobId is mandatory for this action.

错误信息。

ErrorCode String MissingJobId

错误码。

DBTaskSQLJobDetailList Array of DBTaskSQLJobDetail

SQL任务详情列表。

JobDetailId Long 24723****

SQL任务详情ID。

CurrentSql String update a set id = 1 where id = 1;

当前执行的SQL。

ExecuteCount Long 1

执行次数。

JobId Long 1276****

SQL任务ID。

DbId Long 1988****

物理库ID。

Logic Boolean false

是否为逻辑库,返回值如下:

  • true:逻辑库
  • false:物理库
Skip Boolean false

是否存在跳过执行SQL脚本的情况,返回值如下:

  • true:存在
  • false:不存在
SqlType String CREATE_TABLE

SQL类型,例如,DELETE、UPDATE、ALTER_TABLE等。

Status String SUCCESS

SQL详情状态,返回值如下:

  • INIT:初始化状态
  • PENDING:等待任务抓取
  • BE_SCHEDULED:待调度
  • FAIL:执行失败
  • SUCCESS:执行成功
  • PAUSE:暂停
  • DELETE:删除
  • RUNNING:正在执行
Log String log_info

日志详情信息。

StartTime String 2021-12-16 00:00:00

SQL执行开始时间。

EndTime String 2021-12-16 00:00:01

SQL执行结束时间。

TimeDelay Long 38

SQL执行耗时,单位为毫秒。

AffectRows Long 0

SQL执行影响行数。

TotalCount Long 1

SQL任务总数。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListDBTaskSQLJobDetail
&JobId=1276****
&PageNumber=1
&PageSize=20
&Tid=3***
&公共请求参数

正常返回示例

XML格式

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

<ListDBTaskSQLJobDetailResponse>
    <RequestId>3F044E33-FE09-58F1-8C61-A0F612EC****</RequestId>
    <Success>true</Success>
    <ErrorMessage>JobId is mandatory for this action.</ErrorMessage>
    <ErrorCode>MissingJobId</ErrorCode>
    <DBTaskSQLJobDetailList>
        <CurrentSql>update a set id = 1 where id  = 1;</CurrentSql>
        <ExecuteCount>1</ExecuteCount>
        <Logic>false</Logic>
        <Skip>false</Skip>
        <SqlType>CREATE_TABLE</SqlType>
        <Status>SUCCESS</Status>
        <Log>log_info</Log>
        <StartTime>2021-12-16 00:00:00</StartTime>
        <EndTime>2021-12-16 00:00:01</EndTime>
        <TimeDelay>38</TimeDelay>
        <AffectRows>0</AffectRows>
    </DBTaskSQLJobDetailList>
    <TotalCount>1</TotalCount>
</ListDBTaskSQLJobDetailResponse>

JSON格式

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

{
  "RequestId" : "3F044E33-FE09-58F1-8C61-A0F612EC****",
  "Success" : true,
  "ErrorMessage" : "JobId is mandatory for this action.",
  "ErrorCode" : "MissingJobId",
  "DBTaskSQLJobDetailList" : [ {
    "CurrentSql" : "update a set id = 1 where id  = 1;",
    "ExecuteCount" : 1,
    "Logic" : false,
    "Skip" : false,
    "SqlType" : "CREATE_TABLE",
    "Status" : "SUCCESS",
    "Log" : "log_info",
    "StartTime" : "2021-12-16 00:00:00",
    "EndTime" : "2021-12-16 00:00:01",
    "TimeDelay" : 38,
    "AffectRows" : 0
  } ],
  "TotalCount" : 1
}

错误码

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