透過 ListInstances API 查詢節點執行個體 - 大數據開發治理平台 DataWorks

調用ListInstances擷取執行個體的列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectEnv	string	是	啟動並執行環境，包括 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 ，煙霧測試 (Smoke Test) 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 降序返回。	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	調度任務的已耗用時間。	1590422400000
BeginRunningTime	integer	執行個體開始啟動並執行時間。	1590416703313
FinishTime	integer	調度任務的結束時間。	1590416703313
ErrorMessage	string	執行個體啟動並執行報錯資訊。該欄位已廢棄，您可以調用 GetInstanceLog 介面擷取執行任務的相關報錯資訊。	error message
CreateTime	integer	執行個體的建立時間。	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)：煙霧測試 (Smoke Test)工作流程 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	調度任務的最新修改時間。	1590416703313
Repeatability	boolean	執行個體任務是否可以重複執行。	true
RepeatInterval	integer	調度任務運行出錯後，重新調整調度頻率，單位為毫秒（ms）。	60000
InstanceId	integer	執行個體的 ID。	1234
BeginWaitResTime	integer	執行個體任務開始等待資源的時間。	1590416703313
RelatedFlowId	integer	關聯的商務程序 ID。	123456
Bizdate	integer	執行調度任務的日期。通常為該任務已耗用時間的前一天。	1590336000000
NodeName	string	節點的名稱。	kzh
BeginWaitTimeTime	integer	執行個體任務開始等待調度的時間。	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"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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