全部产品
Search
文档中心

数据管理 DMS:ListDBTaskSQLJob - 获取SQL任务列表

更新时间:Mar 17, 2023

获取SQL任务列表。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
DBTaskGroupIdlong

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

1324235
PageNumberlong

第几页。

1
PageSizelong

每页数据量。

20
Tidlong

租户ID。

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

F6C47680-8D2D-43A4-8902-F2740D71A398
Successboolean

请求是否成功。

true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
DBTaskSQLJobListarray

SQL任务列表。

object

SQL任务。

JobIdlong

SQL任务ID。

123435
JobTypestring

SQL任务类型。

STRUCT_SYNC
Commentstring

SQL任务备注信息。

test
DbSearchNamestring

库搜索名。

test@xxx:3306【test】
DbIdlong

库ID。

43214523
Logicboolean

是否为逻辑库,取值:

  • true:是
  • false:否
false
CreateTimestring

创建时间。

2021-02-18 17:49:20
LastExecTimestring

最后执行时间。

2021-02-18 17:49:31
DbTaskGroupIdlong

SQL任务分组ID。

4324132
Statusstring

SQL详情状态,取值:

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

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

  • true:是
  • false:否
false
TotalCountlong

SQL任务列表总数。

1

示例

正常返回示例

JSON格式

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

错误码

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