全部產品
Search
文件中心

DataWorks:ListInstances

更新時間:Oct 09, 2026

呼叫 ListInstances 取得執行個體的清單。

調試

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

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

list

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

ProjectEnv

string

是

執行的環境,包括 PROD(生產環境)和 DEV(開發環境)。

枚舉值:

  • PROD :

    生產環境。

  • DEV :

    開發環境。

PROD

NodeId

integer

否

節點的 ID。您可以呼叫 ListNodes 檢視節點 ID 資訊。

100000000000

NodeName

string

否

節點的名稱。您可以呼叫 ListNodes 檢視節點名稱。

openmr_8****

Owner

string

否

負責人的 ID,即工作空間管理員的帳號 UID。您可登入阿里雲主控台後,在帳號管理的安全管理中檢視帳號 UID。

193379****

ProjectId

integer

是

工作空間的 ID。您可以呼叫 ListProjects 檢視空間 ID 資訊。

12345

BizName

string

否

業務流程的名稱。您可以呼叫 ListBusiness 檢視業務流程資訊。

test_bizName

ProgramType

string

否

節點的類型。您可以呼叫 ListNodes 檢視節點類型。

ODPS_SQL

PageNumber

integer

否

頁碼數,用於翻頁。最小值為 1,最大值為 100。

1

PageSize

integer

否

每頁顯示的筆數,預設為 10 筆,最大 100 筆。

10

DagId

integer

否

DagId 可以是執行補資料 RunCycleDagNodes 、冒煙測試 RunSmokeTest 、手動業務流程 RunManualDagNodes 等介面傳回的 DagId。

11111

Bizdate

string

否

取得執行個體清單的日期,格式為 yyyy-MM-dd HH:mm:ss。

2020-02-02 00:00:00

BeginBizdate

string

否

取得執行個體清單的開始日期,格式為 yyyy-MM-dd HH:mm:ss。

2020-02-02 00:00:00

EndBizdate

string

否

取得執行個體清單的結束日期,格式為 yyyy-MM-dd HH:mm:ss。

2020-02-03 00:00:00

Status

string

否

任務的狀態,取值如下:

  • NOT_RUN(未執行)

  • WAIT_TIME(等待定時時間 DueTime 或 CycTime 到來)

  • WAIT_RESOURCE(等待資源)

  • RUNNING(執行中)

  • CHECKING(下發給資料品質進行資料校驗)

  • CHECKING_CONDITION(正在進行分支條件校驗)

  • FAILURE(執行失敗)

  • SUCCESS(執行成功)

NOT_RUN

OrderBy

string

否

傳回值的排序規則。取值如下:

  • CREATE_TIME_DESC:按照建立時間降序傳回

  • INSTANCE_ID_DESC:預設值,按照執行個體 ID 降序傳回。

枚舉值:

  • CREATE_TIME_DESC :

    按建立時間降序。

  • INSTANCE_ID_DESC :

    按執行個體 ID 降序。

INSTANCE_ID_DESC

返回參數

名稱

類型

描述

樣本值

object

傳回結果。

HttpStatusCode

integer

HTTP 狀態碼。

200

RequestId

string

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

E6F0DBDD-5AD****

ErrorMessage

string

錯誤資訊。

The project does not exist.

ErrorCode

string

錯誤碼。

Invalid.Tenant.ProjectNotExists

Success

boolean

呼叫是否成功。取值如下:

  • true:呼叫成功。

  • false:呼叫失敗。

true

Data

object

執行個體的清單。

PageNumber

integer

頁碼數。

1

PageSize

integer

每頁顯示的筆數,預設為 10 筆,最大為 100 筆。

10

TotalCount

integer

執行個體的總數。

66

Instances

array<object>

執行個體的資訊。

object

傳回資料。

Status

string

任務的狀態,取值如下:

  • NOT_RUN(1):未執行

  • WAIT_TIME(2):等待時間。等待定時時間到來

  • WAIT_RESOURCE(3):等待資源。已經下發到執行引擎,在等待資源排隊排程執行

  • RUNNING(4):執行中

  • CHECKING(7):校驗中。執行完畢,下發給資料品質進行資料校驗

  • CHECKING_CONDITION(8):條件檢測中。執行完畢,正在做分支條件校驗

  • WAIT_TRIGGER(9):等待觸發。觸發式節點會在等待時間後變成等待觸發

  • FAILURE(5):執行失敗

  • SUCCESS(6):執行成功

NOT_RUN

CycTime

integer

排程任務的執行時間。

格式範例為 13 位數字,例如 1590422400000。

1590422400000

BeginRunningTime

integer

執行個體開始執行的時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

FinishTime

integer

排程任務的結束時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

ErrorMessage

string

執行個體執行的錯誤資訊。

該欄位已棄用,您可以呼叫 GetInstanceLog 介面取得執行任務的相關錯誤資訊。

error message

CreateTime

integer

執行個體的建立時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

DagId

integer

工作流程的 ID。

33845

Priority

integer

執行個體執行優先順序,取值分為 1、3、5、7 和 8。

取值越大,優先順序越高。預設優先順序為 1。

1

TaskType

string

任務執行個體的排程類型,取值如下:

  • NORMAL(0):正常排程任務。該任務被日常排程。

  • MANUAL(1):手動任務。該任務不會被日常排程。

  • PAUSE(2):凍結任務。該任務被日常排程,但啟動排程時直接被置為失敗狀態。

  • SKIP(3):空跑任務。該任務被日常排程,但啟動排程時直接被置為成功狀態。

  • SKIP_UNCHOOSE(4):臨時工作流程中未選擇的任務,僅存在於臨時工作流程中,啟動排程時直接被置為成功狀態。

  • SKIP_CYCLE(5):未到執行週期的週或月任務。該任務被日常排程,但啟動排程時直接被置為成功狀態。

  • CONDITION_UNCHOOSE(6):上游執行個體中有分支(IF)節點,但是該下游節點未被分支節點選中,直接置為空跑任務。 REALTIME_DEPRECATED(7):即時產生的已經過期的週期執行個體,該類型的任務直接被置為成功狀態。

NORMAL(0)

ParamValues

string

參數的資訊。

bizdate=$bizdate tbods=$tbods

Connection

string

連線字串。

odps_source

BaselineId

integer

基線 ID。

123123

DqcType

integer

DQC 類型,取值如下:

  • 0 表示有關聯 dqc。

  • 1 表示沒有關聯 dqc。

1

DagType

string

工作流程的類型,取值如下:

  • DAILY(0):日常排程工作流程

  • MANUAL(1):手動任務工作流程

  • SMOKE_TEST(2):冒煙測試工作流程

  • SUPPLY_DATA(3):補資料工作流程

  • MANUAL_FLOW(4):手動執行的 dataflow pai 業務流程等(如 IDE 上點擊執行業務流程)

  • BUSINESS_PROCESS_DAG(5):手動業務流程工作流程

DAILY

BusinessId

integer

業務流程 ID。

123

TaskRerunTime

integer

執行個體還可以執行的次數。取值可以為空,以及大於等於 0 的整數。

  • 取值為空,表示該執行個體對應的節點沒有設定自動重跑次數。

  • 取值為 0,表示該執行個體不能再重跑。

  • 取值為大於 0 的整數(假設為 n),表示該執行個體可重跑次數為 n。例如,該參數取值為 1,則剩餘重跑次數為 1,取值為 2,則剩餘重跑次數為 2,以此類推。初始值為對應節點定義的自動重跑次數 +1。

0

ModifyTime

integer

排程任務的最新修改時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

Repeatability

boolean

執行個體任務是否可以重複執行。

true

RepeatInterval

integer

排程任務執行出錯後,重新調整排程頻率,單位為毫秒(ms)。

60000

InstanceId

integer

執行個體的 ID。

1234

BeginWaitResTime

integer

執行個體任務開始等待資源的時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

RelatedFlowId

integer

關聯的業務流程 ID。

123456

Bizdate

integer

執行排程任務的日期。通常為該任務執行時間的前一天。

格式範例為 13 位數字,例如 1590336000000。

1590336000000

NodeName

string

節點的名稱。

kzh

BeginWaitTimeTime

integer

執行個體任務開始等待排程的時間。

格式範例為 13 位數字,例如 1590416703313。

1590416703313

DqcDescription

string

DQC 分割區規則字串。

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

NodeId

integer

節點的 ID。

33115

CreateUser

string

觸發執行個體執行的使用者。例如,使用者 Test 觸發補資料執行個體執行,則 CreateUser 為 Test。

Test

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The project does not exist.",
  "ErrorCode": "Invalid.Tenant.ProjectNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "CycTime": 1590422400000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "ErrorMessage": "error message",
        "CreateTime": 1590416703313,
        "DagId": 33845,
        "Priority": 1,
        "TaskType": "NORMAL(0)",
        "ParamValues": "bizdate=$bizdate tbods=$tbods",
        "Connection": "odps_source",
        "BaselineId": 123123,
        "DqcType": 1,
        "DagType": "DAILY",
        "BusinessId": 123,
        "TaskRerunTime": 0,
        "ModifyTime": 1590416703313,
        "Repeatability": true,
        "RepeatInterval": 60000,
        "InstanceId": 1234,
        "BeginWaitResTime": 1590416703313,
        "RelatedFlowId": 123456,
        "Bizdate": 1590336000000,
        "NodeName": "kzh",
        "BeginWaitTimeTime": 1590416703313,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "NodeId": 33115,
        "CreateUser": "Test"
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情。