调用ListDBTaskSQLJobDetail获取SQL任务的详情信息_数据管理(DMS)-阿里云帮助中心

获取SQL任务的详情信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
JobId	long	是	SQL 任务 ID，可通过调用接口 ListDBTaskSQLJob 获取该参数的值。	1276****
PageNumber	long	否	开始页码。	1
PageSize	long	否	每页数据量。	20
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	3F044E33-FE09-58F1-8C61-A0F612EC****
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorMessage	string	错误信息。	JobId is mandatory for this action.
ErrorCode	string	错误码。	MissingJobId
DBTaskSQLJobDetailList	array<object>	SQL 任务详情列表。
	object	SQL 任务详情列表。
JobDetailId	long	SQL 任务详情 ID。	24723****
CurrentSql	string	当前执行的 SQL。	update a set id = 1 where id = 1;
ExecuteCount	long	执行次数。	1
JobId	long	SQL 任务 ID。	1276****
DbId	long	物理库 ID。	1988****
Logic	boolean	是否为逻辑库，返回值如下： true：逻辑库 false：物理库	false
Skip	boolean	是否存在跳过执行 SQL 脚本的情况，返回值如下： true：存在 false：不存在	false
SqlType	string	SQL 类型，例如，DELETE、UPDATE、ALTER_TABLE 等。	CREATE_TABLE
Status	string	SQL 详情状态，返回值如下： INIT：初始化状态 PENDING：等待任务抓取 BE_SCHEDULED：待调度 FAIL：执行失败 SUCCESS：执行成功 PAUSE：暂停 DELETE：删除 RUNNING：正在执行	SUCCESS
Log	string	日志详情信息。	log_info
StartTime	string	SQL 执行开始时间。	2021-12-16 00:00:00
EndTime	string	SQL 执行结束时间。	2021-12-16 00:00:01
TimeDelay	long	SQL 执行耗时，单位为毫秒。	38
AffectRows	long	SQL 执行影响行数。	0
TotalCount	long	SQL 任务总数。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "3F044E33-FE09-58F1-8C61-A0F612EC****",
  "Success": true,
  "ErrorMessage": "JobId is mandatory for this action.",
  "ErrorCode": "MissingJobId",
  "DBTaskSQLJobDetailList": [
    {
      "JobDetailId": 0,
      "CurrentSql": "update a set id = 1 where id  = 1;",
      "ExecuteCount": 1,
      "JobId": 0,
      "DbId": 0,
      "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
}

错误码

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

变更历史

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

暂无变更历史