調用GetIDEEventDetail傳入訊息ID查詢擴充點事件數目據快照-巨量資料開發治理平台 DataWorks-阿里雲

根據DataWorks開放訊息的訊息ID，查詢觸發擴充點事件時的擴充點資料快照。

介面說明

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
MessageId	string	是	DataWorks 開放訊息的訊息 ID。當觸發擴充點事件後，您可以從接收到的事件訊息中擷取訊息 ID。	8abcb91f-d266-4073-b907-2ed67****1
ProjectId	integer	是	DataWorks 工作空間的 ID，您可以通過解析 DataWorks 開放訊息擷取空間 ID。	10000

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求的唯一標識，用於後續錯誤排查使用。	8abcb91f-d266-4073-b907-2ed670378ed1
EventDetail	object	觸發擴充點事件時的資料快照。不同類型的訊息事件，資料快照的有效欄位存在差異，具體請參考各訊息事件的欄位說明。
FileExecutionCommand	object	檔案代碼執行時的快照，當 Message 類型為 IDE_FILE_EXECUTE_BEFORE 時有效。
FileId	integer	檔案的 ID。	1234123
DataSourceName	string	檔案關聯的資料來源唯一標識。	odps_source
Content	string	產生本次檔案版本的檔案代碼。	SHOW TABLES;
FileType	integer	檔案類型。不同檔案類型其代碼不同，詳情請參見 DataWorks 節點合集。	10
DeletedFile	object	刪除檔案時的快照資訊，當 Message 類型為 IDE_FILE_DELETE_BEFORE 時有效。
Owner	string	檔案責任人。	7384234****
FileType	integer	檔案類型。不同檔案類型其代碼不同，詳情請參見 DataWorks 節點合集。	10
CurrentVersion	integer	當前檔案的最新版本。	1
BusinessId	integer	檔案所屬的商務程序 ID。	74328
FileName	string	檔案名稱。	hello_dataworks.sql
DataSourceName	string	檔案關聯的資料來源唯一標識。	odps_source
UseType	string	檔案所屬的功能模組。取值如下： NORMAL：資料開發 MANUAL：手動任務 MANUAL_BIZ：手動商務程序 SKIP：資料開發的空跑調度 ADHOCQUERY：臨時查詢 COMPONENT：組件管理	NORMAL
FolderId	string	檔案所屬的檔案夾 ID，您可以調用 GetFolder 介面，通過檔案夾 ID 查詢檔案詳情。	aldurie78l2falure
ParentFileId	integer	檔案所屬的迴圈節點或遍曆節點的節點 ID。	1234122
Content	string	產生本次檔案版本的檔案代碼。	SHOW TABLES;
NodeId	integer	調度節點的 ID。	421429
FileId	integer	檔案的 ID。	1234123
CommittedFile	object	檔案提交和發布時的快照。僅當 Message 類型為 IDE_FILE_SUBMIT_BEFORE 或 IDE_FILE_DEPLOY_BEFORE 時有效。
FileId	integer	檔案的 ID。	1234123
Content	string	產生本次檔案版本的檔案代碼。	SHOW TABLES;
Committor	string	產生本次檔案版本的阿里雲使用者識別碼。	7384234****
FileType	integer	檔案類型。不同檔案類型其代碼不同，詳情請參見 DataWorks 節點合集。	10
ChangeType	string	本次檔案版本的變更類型，包括 CREATE、UPDATE 和 DELETE。	UPDATE
FileName	string	檔案名稱。	hello_dataworks.sql
NodeId	integer	調度節點的 ID。	421429
Comment	string	本次檔案版本的說明。	Second version submission
UseType	string	檔案所屬的功能模組。取值如下： NORMAL：資料開發 MANUAL：手動任務 MANUAL_BIZ：手動商務程序 SKIP：資料開發的空跑調度 ADHOCQUERY：臨時查詢 COMPONENT：組件管理	NORMAL
FilePropertyContent	object	檔案的更多屬性。
DataSourceName	string	檔案關聯的資料來源唯一標識。	odps_source
ParentFileId	integer	檔案所屬的迴圈節點或遍曆節點的節點 ID。	1234122
BusinessId	integer	檔案所屬的商務程序 ID。	74328
CurrentVersion	integer	當前檔案的最新版本。	1
Owner	string	檔案責任人。	7384234****
FolderId	string	檔案所屬的檔案夾 ID，您可以調用 GetFolder 介面，通過檔案夾 ID 查詢檔案詳情。	aldurie78l2falure
NodeConfiguration	object	檔案的調度屬性配置。
RerunMode	string	重跑屬性。取值如下： ALL_ALLOWED：運行成功或失敗後皆可重跑。 FAILURE_ALLOWED：運行成功後不可重跑，運行失敗後可以重跑。 ALL_DENIED：運行成功或失敗皆不可重跑。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>重跑屬性”配置內容對應。	ALL_ALLOWED
SchedulerType	string	調度的類型，取值如下： NORMAL：正常調度任務。 MANUAL：手動任務，不會被日常調度，對應手動商務程序下的節點。 PAUSE：暫停任務。 SKIP：空跑任務，被日常調度，但啟動調度時直接被置為成功。	NORMAL
ParaValue	string	調度參數。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>參數”對應。您可以參考調度參數配置。	a=x b=y
CycleType	string	調度周期的類型，包括 NOT_DAY（分鐘、小時）和 DAY（日、周、月）。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>調度周期”對應。	DAY
DependentNodeIdList	string	當 DependentType 參數配置為 USER_DEFINE 時，用於設定當前檔案具體依賴的節點 ID。依賴多個節點時，使用英文逗號（,）分隔。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴>跨周期依賴（原上一周期）”，依賴項選擇”其他節點“時配置的內容對應。	5,10,15,20
ResourceGroupId	integer	檔案發布成任務後，任務執行時使用的資源群組。您可以調用 ListResourceGroups 擷取工作空間可用的資源群組列表。	375827434852437
AutoRerunTimes	integer	自動重跑次數。	3
AutoRerunIntervalMillis	integer	自動重跑間隔毫秒數。	120000
CronExpress	string	調度 Cron 運算式。	00 05 00 * * ?
InputList	array<object>	檔案依賴的上遊檔案輸出。
	object	依賴的上遊檔案輸出資訊。
Input	string	檔案依賴的上遊檔案的輸出名稱。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴>依賴上遊節點“的”上遊節點輸出名”對應。	dw_project_root
ParseType	string	設定檔依賴的方式，取值如下： MANUAL：手動設定。 AUTO：自動解析。	MANUAL
OutputList	array<object>	檔案的輸出。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴>本節點輸出名稱“對應。
	object	檔案的輸出資訊。
RefTableName	string	檔案的輸出表名。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴>本節點輸出名稱“的“輸出表名”對應。	ods_user_info_d
Output	string	檔案的輸出名稱。該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴>本節點輸出名稱“的“輸出名”對應。	dw_project.002_out
DependentType	string	依賴上一周期的方式。取值如下： SELF：依賴項選擇本節點。 CHILD：依賴項選擇一級子節點。 USER_DEFINE：依賴項選擇其他節點。 NONE：未選擇依賴項，即不會依賴上一周期。	USER_DEFINE
TableModel	object	表提交和發布時的快照，當 Message 類型為 IDE_TABLE_SUBMIT_BEFORE 和 IDE_TABLE_DEPLOY_BEFORE 時有效。
Env	string	表所屬環境。取值如下： DEV：開發環境。 PROD：生產環境。	DEV
LifeCycle	integer	表的生命週期。單位為天。	7
TableName	string	表名稱。	tb_hello
DataSourceName	string	表所屬資料來源的唯一標識。	odps_source
Columns	array<object>	欄位列表。
	object	欄位資訊。
ColumnName	string	欄位名稱。	ID
ColumnType	string	欄位類型。	BIGINT
IsPartitionColumn	boolean	是否為分區欄位，取值如下： true：是分區欄位。 false：非分區欄位。	false
Comment	string	欄位備忘。	ID
Comment	string	表的備忘資訊。	A new table
Location	string	外部表格的 Location 資訊。	hdfs://path/to/object

樣本

正常返回樣本

JSON格式

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "EventDetail": {
    "FileExecutionCommand": {
      "FileId": 1234123,
      "DataSourceName": "odps_source",
      "Content": "SHOW TABLES;",
      "FileType": 10
    },
    "DeletedFile": {
      "Owner": "7384234****",
      "FileType": 10,
      "CurrentVersion": 1,
      "BusinessId": 74328,
      "FileName": "hello_dataworks.sql",
      "DataSourceName": "odps_source",
      "UseType": "NORMAL",
      "FolderId": "aldurie78l2falure",
      "ParentFileId": 1234122,
      "Content": "SHOW TABLES;",
      "NodeId": 421429,
      "FileId": 1234123
    },
    "CommittedFile": {
      "FileId": 1234123,
      "Content": "SHOW TABLES;",
      "Committor": "7384234****",
      "FileType": 10,
      "ChangeType": "UPDATE",
      "FileName": "hello_dataworks.sql",
      "NodeId": 421429,
      "Comment": "Second version submission",
      "UseType": "NORMAL",
      "FilePropertyContent": {
        "DataSourceName": "odps_source",
        "ParentFileId": 1234122,
        "BusinessId": 74328,
        "CurrentVersion": 1,
        "Owner": "7384234****",
        "FolderId": "aldurie78l2falure"
      },
      "NodeConfiguration": {
        "RerunMode": "ALL_ALLOWED",
        "SchedulerType": "NORMAL",
        "ParaValue": "a=x b=y",
        "CycleType": "DAY",
        "DependentNodeIdList": "5,10,15,20",
        "ResourceGroupId": 375827434852437,
        "AutoRerunTimes": 3,
        "AutoRerunIntervalMillis": 120000,
        "CronExpress": "00 05 00 * * ?",
        "InputList": [
          {
            "Input": "dw_project_root",
            "ParseType": "MANUAL"
          }
        ],
        "OutputList": [
          {
            "RefTableName": "ods_user_info_d",
            "Output": "dw_project.002_out"
          }
        ],
        "DependentType": "USER_DEFINE"
      }
    },
    "TableModel": {
      "Env": "DEV",
      "LifeCycle": 7,
      "TableName": "tb_hello",
      "DataSourceName": "odps_source",
      "Columns": [
        {
          "ColumnName": "ID",
          "ColumnType": "BIGINT",
          "IsPartitionColumn": false,
          "Comment": "ID"
        }
      ],
      "Comment": "A new table",
      "Location": "hdfs://path/to/object"
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	沒有許可權，請授權
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

變更歷史

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