調用DeleteFile刪除資料開發檔案-巨量資料開發治理平台 DataWorks-阿里雲

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

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

delete

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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.

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

變更歷史

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