调用ListDBTaskSQLJobDetail获取SQL任务的详情信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
JobId Long 12345

SQL任务ID,您可以调用ListDBTaskSQLJob获取该参数。

PageNumber Long 1

第几页。

PageSize Long 20

每页数据量。

Tid Long 1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见 查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String B5937485-6644-4ADC-82F9-573DFE751708

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

DBTaskSQLJobDetailList Array of DBTaskSQLJobDetail

SQL任务详情列表。

JobDetailId Long 12345

SQL任务ID。

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

当前执行的SQL。

ExecuteCount Long 1

执行次数。

JobId Long 432423

SQL任务ID。

DbId Long 43253

数据库ID。

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
Skip Boolean false

是否有跳过执行SQL脚本,取值:

  • true:是
  • false:否
SqlType String UPDATE

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

Status String SUCCESS

SQL详情状态,取值:

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

SQL总数。

示例

请求示例

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

正常返回示例

XML格式

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

<ListDBTaskSQLJobDetailResponse>
    <TotalCount>2</TotalCount>
    <DBTaskSQLJobDetailList>
        <Status>SUCCESS</Status>
        <Skip>false</Skip>
        <DbId>7000000</DbId>
        <SqlType>CREATE_TABLE</SqlType>
        <ExecuteCount>1</ExecuteCount>
        <Logic>false</Logic>
        <CurrentSql>/* origin table[data_modify] exist, target table[data_modify] not exist */
            
            /* generate [data_modify] create table sql */
            
            create table `data_modify` (
            `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
            `name` varchar(256) NOT NULL COMMENT '姓名',
            `phone` varchar(32) DEFAULT NULL COMMENT '电话',
            `sex` varchar(32) DEFAULT NULL COMMENT '性别',
            `email` varchar(256) DEFAULT NULL COMMENT '邮箱',
            `user_desc` varchar(1024) DEFAULT NULL COMMENT '备注',
            PRIMARY KEY (`id`)
            ) DEFAULT CHARSET=utf8 COMMENT='数据修改测试表'</CurrentSql>
        <JobDetailId>140000004</JobDetailId>
        <JobId>3000000</JobId>
    </DBTaskSQLJobDetailList>
    <DBTaskSQLJobDetailList>
        <Status>SUCCESS</Status>
        <Skip>false</Skip>
        <DbId>7000000</DbId>
        <SqlType>CREATE_TABLE</SqlType>
        <ExecuteCount>1</ExecuteCount>
        <Logic>false</Logic>
        <CurrentSql>
            
            /* origin table[task_data] exist, target table[task_data] not exist */
            
            /* generate [task_data] create table sql */
            
            create table `task_data` (
            `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
            `gmt_create` datetime NOT NULL COMMENT '创建时间',
            `gmt_modified` datetime NOT NULL COMMENT '修改时间',
            `content` text COMMENT '测试数据',
            PRIMARY KEY (`id`)
            ) DEFAULT CHARSET=utf8mb4 COMMENT='任务编排测试表'</CurrentSql>
        <JobDetailId>140000005</JobDetailId>
        <JobId>3000000</JobId>
    </DBTaskSQLJobDetailList>
    <RequestId>F3C2F73D-1B39-4C1D-AC00-882DB2BD61FD</RequestId>
    <Success>true</Success>
</ListDBTaskSQLJobDetailResponse>

JSON格式

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

{
  "TotalCount" : 2,
  "DBTaskSQLJobDetailList" : [ {
    "Status" : "SUCCESS",
    "Skip" : false,
    "DbId" : 7000000,
    "SqlType" : "CREATE_TABLE",
    "ExecuteCount" : 1,
    "Logic" : false,
    "CurrentSql" : "/* origin table[data_modify] exist, target table[data_modify] not exist */\n\n/* generate [data_modify] create table sql */\n\ncreate table `data_modify` (\n  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',\n  `name` varchar(256) NOT NULL COMMENT '姓名',\n  `phone` varchar(32) DEFAULT NULL COMMENT '电话',\n  `sex` varchar(32) DEFAULT NULL COMMENT '性别',\n  `email` varchar(256) DEFAULT NULL COMMENT '邮箱',\n  `user_desc` varchar(1024) DEFAULT NULL COMMENT '备注',\n  PRIMARY KEY (`id`)\n) DEFAULT CHARSET=utf8 COMMENT='数据修改测试表'",
    "JobDetailId" : 140000004,
    "JobId" : 3000000
  }, {
    "Status" : "SUCCESS",
    "Skip" : false,
    "DbId" : 7000000,
    "SqlType" : "CREATE_TABLE",
    "ExecuteCount" : 1,
    "Logic" : false,
    "CurrentSql" : "\n\n/* origin table[task_data] exist, target table[task_data] not exist */\n\n/* generate [task_data] create table sql */\n\ncreate table `task_data` (\n  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',\n  `gmt_create` datetime NOT NULL COMMENT '创建时间',\n  `gmt_modified` datetime NOT NULL COMMENT '修改时间',\n  `content` text COMMENT '测试数据',\n  PRIMARY KEY (`id`)\n) DEFAULT CHARSET=utf8mb4 COMMENT='任务编排测试表'",
    "JobDetailId" : 140000005,
    "JobId" : 3000000
  } ],
  "RequestId" : "F3C2F73D-1B39-4C1D-AC00-882DB2BD61FD",
  "Success" : true
}

错误码

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