调用ListDBTaskSQLJob获取SQL任务列表_数据管理(DMS)-阿里云帮助中心

获取SQL任务列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBTaskGroupId	long	是	SQL 任务分组 ID，您可以调用 GetStructSyncJobDetail 接口获取该参数。	132****
PageNumber	long	否	开始页码。	1
PageSize	long	否	每页数据量。	20
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	1***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F6C47680-8D2D-43A4-8902-F2740D71A398
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
DBTaskSQLJobList	array<object>	SQL 任务列表。
	object	SQL 任务。
JobId	long	SQL 任务 ID。	12****
JobType	string	SQL 任务类型。	STRUCT_SYNC
Comment	string	SQL 任务备注信息。	test
DbSearchName	string	库搜索名。说明建议您的业务不要强依赖该参数，后续版本的格式可能会发生变化。	test@xxx:3306[test]
DbId	long	库 ID。	43214523
Logic	boolean	是否为逻辑库，取值： true：是 false：否	false
CreateTime	string	创建时间。	2021-02-18 17:49:20
LastExecTime	string	最后执行时间。	2021-02-18 17:49:31
DbTaskGroupId	long	SQL 任务分组 ID。	432****
Status	string	SQL 详情状态，取值： INIT：初始化状态 PENDING：等待任务抓取 BE_SCHEDULED：待调度 FAIL：执行失败 SUCCESS：执行成功 PAUSE：暂停 DELETE：删除 RUNNING：正在执行	SUCCESS
Transactional	boolean	是否以事务方式执行，取值： true：是 false：否	false
TotalCount	long	SQL 任务列表总数。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "F6C47680-8D2D-43A4-8902-F2740D71A398",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DBTaskSQLJobList": [
    {
      "JobId": 0,
      "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",
      "DbTaskGroupId": 0,
      "Status": "SUCCESS",
      "Transactional": false
    }
  ],
  "TotalCount": 1
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史