全部產品
Search
文件中心

:DeleteFile - 刪除資料開發中的檔案

更新時間:Mar 21, 2026

調用DeleteFile刪除資料開發中的檔案。如果檔案已經提交過,那麼DeleteFile API會同時觸發一個非同步在調度系統刪除的流程,需要用DeleteFile API返回的DeploymentId繼續調用GetDeployment輪詢被觸發的非同步刪除流程的狀態。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

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

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

10000

ProjectIdentifier

string

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

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

dw_project

FileId

integer

檔案的 ID, 您可以使用 ListFiles 介面查詢對應檔案的 ID。

10000201

返回參數

名稱

類型

描述

樣本值

object

返回結果 。

HttpStatusCode

integer

HTTP 狀態代碼 。

200

DeploymentId

integer

如果檔案已經提交過,那麼 DeleteFile 介面會同時觸發一個非同步在調度系統刪除的流程,需要用 DeleteFile 介面返回的 DeploymentId 繼續調用 GetDeployment 輪詢被觸發的非同步刪除流程的狀態。

如果該欄位為空白,則說明檔案已經刪除完畢,無需繼續輪詢。

1000000001

RequestId

string

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

0000-ABCD-EFG****

ErrorMessage

string

錯誤資訊 。

The connection does not exist.

Success

boolean

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

  • true:調用成功。

  • false:調用失敗。

true

ErrorCode

string

錯誤碼 。

Invalid.Tenant.ConnectionNotExists

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "DeploymentId": 1000000001,
  "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.

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

變更歷史

更多資訊,參考變更詳情