ListTasks - 擷取工作清單

更新時間:
Copy as MD

分頁擷取工作清單,也可以通過條件進行篩選查詢。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

ProjectEnv

string

專案環境。

枚舉值:

  • Prod :

    生產

  • Dev :

    開發

Prod

ProjectId

integer

專案 ID。

100

Name

string

名稱,支援模糊查詢。

SQL node

Ids

array

任務的 ID 列表,可根據任務 Id 批量查詢任務。

integer

任務 ID。

1234

Owner

string

任務的責任人的帳號 ID。

1000

TaskType

string

任務類型。例如:

  • ODPS_SQL

  • SPARK

  • PY_ODPS

  • PY_ODPS3

  • ODPS_SCRIPT

  • ODPS_MR

  • COMPONENT_SQL

  • EMR_HIVE

  • EMR_MR

  • EMR_SPARK_SQL

  • EMR_SPARK

  • EMR_SHELL

  • EMR_PRESTO

  • EMR_IMPALA

  • SPARK_STREAMING

  • EMR_KYUUBI

  • EMR_TRINO

  • HOLOGRES_SQL

  • HOLOGRES_SYNC_DDL

  • HOLOGRES_SYNC_DATA

ODPS_SQL

RuntimeResource

string

資源群組資訊,這裡請填入調度資源群組標識符。

S_res_group_524258031846018_1684XXXXXXXXX

WorkflowId

integer

所屬工作流程的 ID。

1234

TriggerType

string

觸發方式類型。

枚舉值:

  • Scheduler :

    調度周期觸發

  • Manual :

    手動觸發

Scheduler

TriggerRecurrence

string

觸發時的運行模式,TriggerType=Scheduler 時生效。

枚舉值:

  • Pause :

    暫停

  • Skip :

    空跑

  • Normal :

    正常運行

Normal

SortBy

string

排序欄位。支援修改時間、建立時間等欄位,格式為"排序欄位+排序方式(Desc/Asc)"(Asc 可以預設)。排序欄位的枚舉值如下:

  • ModifyTime (Desc/Asc)

  • CreateTime (Desc/Asc)

  • Id (Desc/Asc)

    預設值:Id Desc

Id Desc

PageSize

integer

每頁的條目數,預設為 10,最大為 1000。

10

PageNumber

integer

頁碼,從 1 開始,預設為 1。

1

返回參數

名稱

類型

描述

樣本值

object

ResultModel

RequestId

string

請求的 ID,用於定位日誌,排查問題。

22C97E95-F023-56B5-8852-B1A77A17XXXX

PagingInfo

object

分頁資訊。

TotalCount

integer

資料總條數。

100

PageSize

integer

每頁的條目數。

10

PageNumber

integer

頁碼。

1

Tasks

array<object>

工作清單。

array<object>

Name

string

名稱。

SQL node

Description

string

描述資訊。

test

WorkflowId

integer

所屬工作流程的 ID。

1234

InstanceMode

string

執行個體產生模式。

  • T+1(第二天產生)

  • Immediately(立即產生)

T+1

Type

string

任務類型。

ODPS_SQL

BaselineId

integer

基準 ID。

1234

Priority

integer

任務優先順序,最小值 1,最大值 8。取值越大,優先順序越高。預設優先順序為 1。

1

Timeout

integer

任務執行逾時時間,單位秒。

3600

RerunMode

string

任務是否允許重跑的配置。

枚舉值:

  • AllDenied :

    失敗或成功都不可重跑

  • FailureAllowed :

    只有失敗可重跑

  • AllAllowed :

    失敗或成功均可重跑

AllAllowed

RerunTimes

integer

重試次數,當任務設定為可重跑時生效。

3

RerunInterval

integer

重試時間間隔,單位秒。

60

Trigger

object

任務觸發方式。

Type

string

觸發方式類型。

枚舉值:

  • Scheduler :

    調度周期觸發

  • Manual :

    手動觸發

Scheduler

Recurrence

string

觸發時的運行模式,type=Scheduler 時生效。

枚舉值:

  • Pause :

    暫停

  • Skip :

    空跑

  • Normal :

    正常運行

Normal

Cron

string

Cron 運算式,type=Scheduler 時生效。

00 00 00 * * ?

StartTime

string

周期觸發生效時間,type=Scheduler 時生效。

1970-01-01 00:00:00

EndTime

string

周期觸發失效時間,type=Scheduler 時生效。

9999-01-01 00:00:00

RuntimeResource

object

運行環境配置,如資源群組資訊。

ResourceGroupId

string

任務回合組態的調度資源群組標識符。

S_res_group_524258031846018_1684XXXXXXXXX

Image

string

任務回合組態的鏡像 ID。

i-xxxxxx

Cu

string

任務回合組態 CU 消耗。

0.25

DataSource

object

關聯資料來源資訊。

Name

string

資料來源名稱。

mysql_test

Id

integer

任務的唯一識別碼。

1234

ProjectId

integer

專案 ID。

100

ProjectEnv

string

專案環境。

枚舉值:

  • Prod :

    生產

  • Dev :

    開發

Prod

Owner

string

任務的責任人的帳號 ID。

1000

CreateTime

integer

建立時間。

1710239005403

ModifyTime

integer

修改時間。

1710239005403

CreateUser

string

建立使用者的帳號 ID。

1000

ModifyUser

string

修改使用者的帳號 ID。

1000

ScriptParameters

string

指令碼參數列表。

para1=$bizdate para2=$[yyyymmdd]

樣本

正常返回樣本

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "Tasks": [
      {
        "Name": "SQL node\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "InstanceMode": "T+1",
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "Trigger": {
          "Type": "Scheduler\n",
          "Recurrence": "Normal\n",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00\n",
          "EndTime": "9999-01-01 00:00:00\n"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "ScriptParameters": "para1=$bizdate para2=$[yyyymmdd] "
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情