全部產品
Search

搜尋本產品

    DataWorks：CreateFile - 在資料開發中建立一個檔案

    文件中心

    DataWorks：CreateFile - 在資料開發中建立一個檔案

    更新時間：Mar 21, 2026

    調用CreateFile，在資料開發中建立一個檔案。目前不支援調用該介面建立Data Integration節點任務。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:*

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    FileFolderPath

    string

    否

    檔案的路徑。

    Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2
    ProjectId

    integer

    否

    DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。

    該參數與 ProjectIdentifier 參數，二者必須設定其一，用來確定本次 API 呼叫操作的 DataWorks 工作空間。

    10000
    FileName

    string

    是

    檔案的名稱。

    File name
    FileDescription

    string

    否

    檔案的描述資訊。

    這裡是檔案描述
    FileType

    integer

    是

    檔案的代碼類型。 不同檔案類型其代碼不同，詳情請參見 DataWorks 節點合集。

    您可以調用 ListFileType 介面，查詢檔案的代碼類型。

    10
    Owner

    string

    否

    檔案責任人的阿里雲使用者識別碼。如果該參數為空白，則預設使用調用者的阿里雲使用者識別碼。

    1000000000001
    Content

    string

    否

    檔案代碼內容，不同代碼類型（fileType）的檔案，代碼格式不同。您可以在營運中心找到對應類型的任務，按右鍵查看代碼，查看具體的代碼格式。

    SHOW TABLES;
    AutoRerunTimes

    integer

    否

    出錯自動重跑的次數，取值最大為 10。

    3
    AutoRerunIntervalMillis

    integer

    否

    出錯自動重跑時間間隔，單位為毫秒。最大為 1800000 毫秒（30 分鐘）。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>出錯自動重跑”的”重跑間隔“配置對應。 控制台中“重跑間隔”的時間單位為分鐘，請在調用時注意轉換時間。

    120000
    RerunMode

    string

    否

    重跑屬性。取值如下：

    • ALL_ALLOWED：運行成功或失敗後皆可重跑。

    • FAILURE_ALLOWED：運行成功後不可重跑，運行失敗後可以重跑。

    • ALL_DENIED：運行成功或失敗皆不可重跑。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>重跑屬性”配置內容對應。

    ALL_ALLOWED
    Stop

    boolean

    否

    是否暫停調度，取值如下：

    • true：暫停調度。

    • false：不暫停調度。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>調度類型”配置為”暫停調度“時對應。

    false
    ParaValue

    string

    否

    調度參數。多個參數之間用空格進行分割。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>參數”對應。您可以參考調度參數配置。

    a=x b=y
    StartEffectDate

    integer

    否

    開始自動調度的毫秒時間戳記。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>生效日期”配置的開始時間的毫秒時間戳記對應。

    1671608450000
    EndEffectDate

    integer

    否

    停止自動調度的時間戳記，單位為毫秒。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>生效日期”配置的結束時間的毫秒時間戳記對應。

    1671694850000
    CronExpress

    string

    否

    周期調度的 cron 運算式，該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>cron 運算式”對應。配置完“調度周期”及“定時調度時間”後，DataWorks 會自動產生相應 cron 運算式。

    樣本如下：

    • 每天淩晨 5 點 30 分定時調度：00 30 05 * * ?

    • 每個小時的第 15 分鐘定時調度：00 15 00-23/1 * * ?

    • 每隔十分鐘調度一次：00 00/10 * * * ?

    • 每天 8 點到 17 點，每隔十分鐘調度一次：00 00-59/10 8-17 * * * ?

    • 每月的 1 日 0 點 20 分自動調度：00 20 00 1 * ?

    • 從 1 月 1 日 0 點 10 分開始，每過 3 個月調度一次：00 10 00 1 1-12/3 ?

    • 每周二、周五的 0 點 5 分自動調度：00 05 00 * * 2,5

    由於 DataWorks 調度系統的規則，cron 運算式有以下限制：

    • 最短調度間隔時間為 5 分鐘。

    • 每天最早調度時間為 0 點 5 分。

    00 05 00 * * ?
    CycleType

    string

    否

    調度周期的類型，包括 NOT_DAY（分鐘、小時）和 DAY（日、周、月）。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>時間屬性>調度周期”對應。

    DAY
    DependentType

    string

    否

    依賴上一周期的方式。取值如下：

    • SELF：依賴項選擇本節點。

    • CHILD：依賴項選擇一級子節點。

    • USER_DEFINE：依賴項選擇其他節點。

    • NONE：未選擇依賴項，即不會依賴上一周期。

    • USER_DEFINE_AND_SELF： 跨周期依賴本節點和其他節點的組合的情況

    • CHILD_AND_SELF：跨周期依賴一層子節點和本節點的組合的情況

    NONE
    DependentNodeIdList

    string

    否

    依賴上一周期的節點列表。

    abc
    InputList

    string

    否

    檔案依賴的上遊檔案的輸出名稱，多個輸出使用英文逗號（,）分隔。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴“選擇”同周期“時的”父節點輸出名稱”對應。

    project_root,project.file1,project.001_out
    ProjectIdentifier

    string

    否

    DataWorks 工作空間的名稱。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間名稱。

    該參數與 ProjectId 參數，二者必須設定其一，用來確定本次 API 呼叫操作的 DataWorks 工作空間。

    dw_project
    ResourceGroupIdentifier

    string

    否

    檔案發布成任務後，任務執行時對應的資源群組。您可以調用 ListResourceGroups 通過 identifier 欄位擷取工作空間可用的資源群組列表。

    說明

    您需確認 ListResourceGroups 介面返回的資源群組已綁定至建立檔案所使用的工作空間，綁定後才能在 CreateFile 中使用。

    group_375827434852437
    ResourceGroupId

    integer

    否

    該欄位已廢棄，請勿使用。

    檔案發布成任務後，任務執行時對應的資源群組。對應頁面上調度配置>資源屬性>調度資源群組的配置。與 ResourceGroupIdentifier 二者設定其一即可。

    您可以通過 ListResourceGroups 介面擷取工作空間可用的資源群組列表。ResourceGroupType 傳 1，拿到結果後取出 ID 欄位。

    375827434852437
    ConnectionName

    string

    否

    檔案發布成任務後，任務執行時串連的資料來源。 您可以調用 UpdateDataSource 介面擷取工作空間可用的資料來源列表。

    odps_source
    AutoParsing

    boolean

    否

    檔案是否開啟自動解析功能。取值如下：

    • true：檔案會自動解析代碼。

    • false：檔案不會自動解析代碼。

    該參數與 DataWorks 控制台中，資料開發工作單位的“調度配置>調度依賴”選擇“同周期”時的“代碼解析”對應。

    true
    SchedulerType

    string

    否

    調度的類型，取值如下：

    • NORMAL：正常調度任務。

    • MANUAL：手動任務，不會被日常調度，對應手動商務程序下的節點。

    • PAUSE：暫停任務。

    • SKIP：空跑任務，被日常調度，但啟動調度時直接被置為成功。

    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：沿用上一周期空跑屬性。

    • false：不沿用上一周期空跑屬性。

    false
    CreateFolderIfNotExists

    boolean

    否

    當參數中指定的目錄（FileFolderPath）在系統中不存在時，是否自動建立此目錄。取值如下：

    • true：若此目錄不存在，自動建立此目錄

    • false：若此目錄不存在，調用失敗

    false
    ApplyScheduleImmediately

    boolean

    否

    是否發布後立即生效調度配置

    true
    Timeout

    integer

    否

    調度配置逾時定義

    1
    ImageId

    string

    否

    自訂鏡像 ID

    m-bp1h4b5a8ogkbll2f3tr

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    Data

    integer

    檔案建立成功後的 ID。

    1000001
    RequestId

    string

    本次調用的唯一 ID。出現錯誤後，您可以根據該 ID 排查問題。

    0000-ABCD-EFG
    ErrorMessage

    string

    錯誤資訊。

    The connection does not exist.
    Success

    boolean

    調用是否成功。取值如下：

    • true：調用成功。

    • false：調用失敗。

    true
    ErrorCode

    string

    錯誤碼。

    Invalid.Tenant.ConnectionNotExists

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "Data": 1000001,
  "RequestId": "0000-ABCD-EFG",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing 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.

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

    變更歷史

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