全部产品
Search

搜索本产品

    数据管理 DMS：ListDBTaskSQLJobDetail - 获取SQL任务的详情信息

    文档中心

    数据管理 DMS：ListDBTaskSQLJobDetail - 获取SQL任务的详情信息

    更新时间：Nov 06, 2024

    获取SQL任务的详情信息。

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dms:ListDBTaskSQLJobDetaillist
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    JobIdlong是

    SQL 任务 ID，可通过调用接口 ListDBTaskSQLJob 获取该参数的值。

    		1276****
    PageNumberlong否

    开始页码。

    		1
    PageSizelong否

    每页数据量。

    		20
    Tidlong否

    租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。

    		3***

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    		3F044E33-FE09-58F1-8C61-A0F612EC****
    Successboolean

    请求是否成功，返回值如下：

    • true：请求成功
    • false：请求失败
    		true
    ErrorMessagestring

    错误信息。

    		JobId is mandatory for this action.
    ErrorCodestring

    错误码。

    		MissingJobId
    DBTaskSQLJobDetailListarray<object>

    SQL 任务详情列表。

    DBTaskSQLJobDetailobject

    SQL 任务详情列表。

    JobDetailIdlong

    SQL 任务详情 ID。

    		24723****
    CurrentSqlstring

    当前执行的 SQL。

    		update a set id = 1 where id = 1;
    ExecuteCountlong

    执行次数。

    		1
    JobIdlong

    SQL 任务 ID。

    		1276****
    DbIdlong

    物理库 ID。

    		1988****
    Logicboolean

    是否为逻辑库，返回值如下：

    • true：逻辑库
    • false：物理库
    		false
    Skipboolean

    是否存在跳过执行 SQL 脚本的情况，返回值如下：

    • true：存在
    • false：不存在
    		false
    SqlTypestring

    SQL 类型，例如，DELETE、UPDATE、ALTER_TABLE 等。

    		CREATE_TABLE
    Statusstring

    SQL 详情状态，返回值如下：

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

    日志详情信息。

    		log_info
    StartTimestring

    SQL 执行开始时间。

    		2021-12-16 00:00:00
    EndTimestring

    SQL 执行结束时间。

    		2021-12-16 00:00:01
    TimeDelaylong

    SQL 执行耗时，单位为毫秒。

    		38
    AffectRowslong

    SQL 执行影响行数。

    		0
    TotalCountlong

    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
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史