GetDISyncInstanceInfo擷取即時同步任務與同步解決方案的運行狀態-巨量資料開發治理平台 DataWorks-阿里雲

擷取即時同步任務和同步解決方案任務的運行狀態。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間管理頁面擷取 ID。該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。	10000
TaskType	string	是	目標資料來源所關聯的Data Integration同步任務的任務類型。取值如下： DI_REALTIME：表示Data Integration即時同步任務。 DI_SOLUTION：表示Data Integration同步解決方案。	DI_REALTIME
FileId	integer	是	當 TaskType 為 DI_REALTIME 時，則 FileId 為即時同步任務的檔案 ID。當 TaskType 為 DI_SOLUTION 時，則 FileId 為同步解決方案的任務 ID。您可以調用 ListFiles 介面擷取任務 ID。	100

返回參數

名稱	類型	描述	樣本值
	object	Data Integration同步任務返回的資料結構。
Success	boolean	請求是否成功。取值如下： true：成功。 false：失敗。	true
RequestId	string	請求 ID。用於定位日誌，排查問題。	0bc1411515937635973****
Data	object	擷取同步任務的運行狀態。
Status	string	如果 taskType 為 DI_REALTIME，則 status 為即時任務的運行狀態。包括：PAUSE、NORUN、RUN、KILLING、WAIT。如果 taskType 為 DI_SOLITION，則 status 為同步解決方案的運行狀態。包括：success、fail。	RUN
Message	string	擷取同步任務運行狀態失敗後的原因描述。如果擷取Data Integration同步任務成功，則該參數的傳回值為空白。	fileId[100] is invalid
Name	string	如果 taskType 為 DI_REALTIME，則 name 為即時同步任務的名稱。如果 taskType 為 DI_SOLITION，則 name 為空白。	streamx_name
SolutionInfo	object	如果 taskType 為 DI_REALTIME，則 SolutionInfo 為空白。如果 taskType 為 DI_SOLITION，則 SolutionInfo 為同步解決方案運行詳情。
Status	string	同步解決方案運行狀態。	run
Id	integer	同步解決方案任務 ID。	100
CreatorName	string	同步解決方案任務建立者名稱。	dataworks_3h1
StepDetail	array<object>	同步解決方案任務運行步驟詳情。
	object	Data Integration同步任務返回的資料結構。
Status	string	同步解決方案運行步驟的狀態。	success
StepId	integer	同步解決方案運行步驟的 ID。	1
StepName	string	同步解決方案運行步驟的名稱。	Create a base table
Info	string	同步解決方案運行資訊	{\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"}

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "RUN",
    "Message": "fileId[100] is invalid",
    "Name": "streamx_name",
    "SolutionInfo": {
      "Status": "run",
      "Id": 100,
      "CreatorName": "dataworks_3h1",
      "StepDetail": [
        {
          "Status": "success",
          "StepId": 1,
          "StepName": "Create a base table",
          "Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Real-time synchronization name\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Status\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
        }
      ]
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Param.Invalid	The parameter is invalid.	參數錯誤
500	InternalError.System	An internal error occurred.	內部報錯
403	Forbidden.Access	Access is forbidden.

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

變更歷史

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