調用UpdateFile更新已創建的文件。
接口說明
調試或調用該接口時，填寫的參數必須與該節點原本的文件配置不同。例如，源節點的某參數值為 A，則需要變更為 B 后再提交。如果仍填寫 A，會報 invalid 異常。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dataworks:* | update | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileFolderPath | string | 否 | 文件所在的路徑。 | 業務流程/第一個業務流程/數據集成/文件夾1/文件夾2 |
| ProjectId | long | 否 | DataWorks 工作空間的 ID。您可以登錄 DataWorks 控制臺，進入工作空間管理頁面獲取 ID。 | 10000 |
| FileName | string | 否 | 文件的名稱。您可以通過重新設置 FileName 的值來修改文件名稱。 例如，使用 ListFiles 接口查詢目標目錄下的文件 ID，通過 UpdateFile 接口，輸入查詢的文件 ID 至 FileId 參數，并配置 FileName 的參數值，即可修改相應文件的名稱。 | ods_user_info_d |
| FileDescription | string | 否 | 文件的描述。 | 這里是文件描述 |
| Content | string | 否 | 文件代碼內容，不同代碼類型（fileType）的文件，代碼格式不同。您可以在運維中心，右鍵單擊對應類型的任務，選擇查看代碼，查看具體的代碼格式。 | SELECT "1"; |
| AutoRerunTimes | integer | 是 | 文件出錯后，自動重跑的次數。 | 3 |
| AutoRerunIntervalMillis | integer | 否 | 出錯自動重跑時間間隔，單位為毫秒。最大為 1800000 毫秒（30 分鐘）。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>時間屬性>出錯自動重跑”的”重跑間隔“配置對應。 控制臺中“重跑間隔”的時間單位為分鐘，請在調用時注意轉換時間。 | 120000 |
| RerunMode | string | 否 | 重跑屬性。取值如下：
該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>時間屬性>重跑屬性”配置內容對應。 枚舉值：
| ALL_ALLOWED |
| Stop | boolean | 否 | false | |
| ParaValue | string | 否 | 調度參數。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>參數”對應。您可以參考調度參數配置。 | x=a y=b z=c |
| StartEffectDate | long | 否 | 開始自動調度的毫秒時間戳。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>時間屬性>生效日期”配置的開始時間的毫秒時間戳對應。 | 936923400000 |
| EndEffectDate | long | 否 | 停止自動調度的時間戳，單位為毫秒。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>時間屬性>生效日期”配置的結束時間的毫秒時間戳對應。 | 4155787800000 |
| CronExpress | string | 否 | 周期調度的 cron 表達式，該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>時間屬性>cron 表達式”對應。配置完“調度周期”及“定時調度時間”后，DataWorks 會自動生成相應 cron 表達式。 示例如下：
由于 DataWorks 調度系統的規則，cron 表達式有以下限制：
| 00 00-59/5 1-23 * * ? |
| CycleType | string | 否 | 調度周期的類型，包括 NOT_DAY（分鐘、小時）和 DAY（日、周、月）。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>時間屬性>調度周期”對應。 | NOT_DAY |
| DependentType | string | 否 | 依賴上一周期的方式。取值如下：
| USER_DEFINE |
| DependentNodeIdList | string | 否 | 當 DependentType 參數配置為 USER_DEFINE 時，用于設置當前文件具體依賴的節點 ID。依賴多個節點時，使用英文逗號（,）分隔。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>調度依賴”配置為“上一周期”后，依賴項選擇”其他節點“時配置的內容對應。 | 5,10,15,20 |
| InputList | string | 否 | 文件依賴的上游文件的輸出名稱。依賴多個輸出時，使用英文逗號（,）分隔。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>調度依賴“選擇”同周期“時的”父節點輸出名稱”對應。 說明
通過 CreateDISyncTask 和 UpdateFile 方式創建離線同步任務時此參數必須配置。
| project_root,project.file1,project.001_out |
| ProjectIdentifier | string | 否 | DataWorks 工作空間的名稱。您可以登錄 DataWorks 控制臺，進入工作空間配置頁面獲取工作空間名稱。 該參數與 ProjectId 參數，二者必須設置其一，用來確定本次 API 調用操作的 DataWorks 工作空間。 | dw_project |
| FileId | long | 是 | 文件的 ID。您可以調用 ListFiles 接口獲取文件 ID。 | 100000001 |
| OutputList | string | 否 | 文件的輸出。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>調度依賴“選擇”同周期“時的”本節點的輸出名稱”對應。 | dw_project.ods_user_info_d |
| ResourceGroupIdentifier | string | 否 | 文件發布成任務后，任務執行時對應的資源組。您可以調用 ListResourceGroups 獲取工作空間可用的資源組列表。 | default_group |
| ConnectionName | string | 否 | 文件對應任務執行時，任務使用的數據源標識符。您可以調用 ListDataSources 獲取可用的數據源列表。 | odps_source |
| Owner | string | 否 | 文件所有者的用戶 ID。 | 18023848927592 |
| AutoParsing | boolean | 否 | 文件是否開啟自動解析功能。取值如下：
該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>調度依賴”選擇“同周期”時的“代碼解析”對應。 | true |
| SchedulerType | string | 否 | 調度的類型，取值如下：
| NORMAL |
| AdvancedSettings | string | 否 | 任務的高級配置。 該參數與 DataWorks 控制臺中，EMR Spark Streaming 和 EMR Streaming SQL 數據開發任務，編輯頁面右側導航欄的“高級設置“對應。 當前僅 EMR Spark Streaming 和 EMR Streaming SQL 任務支持配置該參數，并且參數為 JSON 格式。 | {"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"} |
| StartImmediately | boolean | 否 | 發布后是否立即啟動。取值如下：
該參數與 DataWorks 控制臺中，EMR Spark Streaming 和 EMR Streaming SQL 數據開發任務，編輯頁面右側導航欄的“配置>時間屬性>啟動方式“對應。 | true |
| InputParameters | string | 否 | 節點的上下文輸入參數。參數為 JSON 格式，包含的字段可參考 GetFile 接口返回值中的 InputContextParameterList 參數結構。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>節點上下文>本節點輸入參數“對應。 | [{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}] |
| OutputParameters | string | 否 | 節點的上下文輸出參數。參數為 JSON 格式，包含的字段可參考 GetFile 接口返回值中的 OutputContextParameterList 參數結構。 該參數與 DataWorks 控制臺中，數據開發任務的“調度配置>節點上下文>本節點輸出參數“對應。 | [{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}] |
| IgnoreParentSkipRunningProperty | boolean | 否 | 調度配置->上一周期->是否跳過上游的空跑屬性 | true |
| ApplyScheduleImmediately | boolean | 否 | 是否發布后立即生效調度配置 | true |
| Timeout | integer | 否 | 調度配置超時定義 | 1 |
返回參數
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 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. | DataWorks系統繁忙，請稍后再試。 |
| 429 | Throttling.User | Your request is too frequent. Try again later. | 您的請求過于頻繁，請嘗試放緩請求速度。 |
| 500 | InternalError.System | An internal system error occurred. Try again later. | 系統內部錯誤，請稍后再試。 |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系統內部錯誤，請稍后再試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-13 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-09-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-04-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-04-25 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |