全部產品
Search
文件中心

DataWorks:SubmitFile - 提交檔案至調度系統開發環境

更新時間:Apr 22, 2026

提交檔案至調度系統的開發環境,產生對應的任務。

介面說明

本介面為非同步呼叫。提交成功後,系統將返回 DeploymentId。您需要使用該 ID 調用 GetDeployment 介面,以查詢部署任務的實際執行狀態及最終結果。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

update

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

DataWorks 工作空間的 ID。您可以登入 DataWorks 管控台,進入工作空間配置頁面擷取工作空間 ID。該參數與 ProjectIdentifier 參數,二者必須設定其一,用來確定本次 API 呼叫操作的 DataWorks 工作空間。

100001

ProjectIdentifier

string

DataWorks 工作空間名稱。您可以登入 DataWorks 控制台,進入工作空間配置頁面擷取工作空間名稱。該參數與 ProjectId 參數,二者必須設定其一,用來確定本次 API 呼叫操作的 DataWorks 工作空間。

dw_project

FileId

integer

檔案的 ID,您可以通過 ListFiles 查詢對應檔案的 ID。

1000000

Comment

string

本次提交的說明資訊。

Submit a task for the first time

SkipAllDeployFileExtensions

boolean

檔案提交成功後是否跳過發布前檢查:

  • false:不跳過。檔案提交後會自動觸發發布前檢查流程,檢查通過後才會進入可發布狀態。

  • true:跳過。檔案提交後不會觸發發布前檢查流程,可直接進入發布流程。

false

返回參數

名稱

類型

描述

樣本值

object

返回資料。

HttpStatusCode

integer

HTTP 狀態代碼。

200

Data

integer

發布包的 ID,後續需要將該 ID 作為參數調用 GetDeployment 介面,擷取本次發布的具體情況。

3000001

RequestId

string

請求 ID。用於出現錯誤後排查問題。

0000-ABCD-EFG****

ErrorMessage

string

錯誤資訊。

The connection does not exist.

Success

boolean

調用是否成功。

true

ErrorCode

string

錯誤碼。

Invalid.Tenant.ConnectionNotExists

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "Data": 3000001,
  "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.

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

變更歷史

更多資訊,參考變更詳情