调用ListDBTaskSQLJob获取SQL任务列表。

调试

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

请求参数

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

系统规定参数。取值:ListDBTaskSQLJob

DBTaskGroupId Long 132****

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 12****

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 432****

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/?Action=ListDBTaskSQLJob
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式

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

<ListDBTaskSQLJobResponse>
    <RequestId>F6C47680-8D2D-43A4-8902-F2740D71A398</RequestId>
    <Success>true</Success>
    <ErrorMessage>UnknownError</ErrorMessage>
    <ErrorCode>UnknownError</ErrorCode>
    <DBTaskSQLJobList>
        <JobType>STRUCT_SYNC</JobType>
        <Comment>test</Comment>
        <DbSearchName>test@xxx:3306【test】</DbSearchName>
        <DbId>43214523</DbId>
        <Logic>false</Logic>
        <CreateTime>2021-02-18 17:49:20</CreateTime>
        <LastExecTime>2021-02-18 17:49:31</LastExecTime>
        <Status>SUCCESS</Status>
        <Transactional>false</Transactional>
    </DBTaskSQLJobList>
    <TotalCount>1</TotalCount>
</ListDBTaskSQLJobResponse>

JSON格式

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

{
  "RequestId" : "F6C47680-8D2D-43A4-8902-F2740D71A398",
  "Success" : true,
  "ErrorMessage" : "UnknownError",
  "ErrorCode" : "UnknownError",
  "DBTaskSQLJobList" : [ {
    "JobType" : "STRUCT_SYNC",
    "Comment" : "test",
    "DbSearchName" : "test@xxx:3306【test】",
    "DbId" : 43214523,
    "Logic" : false,
    "CreateTime" : "2021-02-18 17:49:20",
    "LastExecTime" : "2021-02-18 17:49:31",
    "Status" : "SUCCESS",
    "Transactional" : false
  } ],
  "TotalCount" : 1
}

错误码

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