调用ListDBTaskSQLJob获取SQL任务列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
DBTaskGroupId Long 1324235

SQL任务分组ID,您可以调用GetStructSyncJobDetail接口获取该参数。

PageNumber Long 1

第几页。

PageSize Long 20

每页数据量。

Tid Long 1

租户ID。

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String F6C47680-8D2D-43A4-8902-F2740D71A398

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

DBTaskSQLJobList Array of DBTaskSQLJob

SQL任务列表。

JobId Long 123435

SQL任务ID。

JobType String STRUCT_SYNC

SQL任务类型。

Comment String test

SQL任务备注信息。

DbSearchName String test@xxx:3306【test】

库搜索名。

DbId Long 43214523

库ID。

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
CreateTime String 2021-02-18 17:49:20

创建时间。

LastExecTime String 2021-02-18 17:49:31

最后执行时间。

DbTaskGroupId Long 4324132

SQL任务分组ID。

Status String SUCCESS

SQL详情状态,取值:

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

是否以事务方式执行,取值:

  • true:是
  • false:否
TotalCount Long 1

SQL任务列表总数。

示例

请求示例

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

正常返回示例

XML格式

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

<ListDBTaskSQLJobResponse>
    <DBTaskSQLJobList>
        <Status>SUCCESS</Status>
        <Comment>结构同步[2100000]的第1个任务, 任务的编号为: 200000</Comment>
        <LastExecTime>2021-03-04 16:58:56</LastExecTime>
        <DbSearchName>film@rm-ufxxxx0000.mysql.rds.aliyuncs.com:3306</DbSearchName>
        <JobType>STRUCT_SYNC</JobType>
        <CreateTime>2021-03-04 16:58:55</CreateTime>
        <DbTaskGroupId>3000000</DbTaskGroupId>
        <DbId>7000003</DbId>
        <Logic>false</Logic>
        <JobId>3000000</JobId>
        <Transactional>false</Transactional>
    </DBTaskSQLJobList>
    <TotalCount>1</TotalCount>
    <RequestId>70639324-89B3-478A-90FE-E0844E02E9DC</RequestId>
    <Success>true</Success>
</ListDBTaskSQLJobResponse>

JSON格式

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

{
  "DBTaskSQLJobList" : [ {
    "Status" : "SUCCESS",
    "Comment" : "结构同步[2100000]的第1个任务, 任务的编号为: 200000",
    "LastExecTime" : "2021-03-04 16:58:56",
    "DbSearchName" : "film@rm-ufxxxx0000.mysql.rds.aliyuncs.com:3306",
    "JobType" : "STRUCT_SYNC",
    "CreateTime" : "2021-03-04 16:58:55",
    "DbTaskGroupId" : 3000000,
    "DbId" : 7000003,
    "Logic" : false,
    "JobId" : 3000000,
    "Transactional" : false
  } ],
  "TotalCount" : 1,
  "RequestId" : "70639324-89B3-478A-90FE-E0844E02E9DC",
  "Success" : true
}

错误码

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