DeleteFile - DataWorks - Alibaba Cloud Documentation Center

Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to view the workspace name. You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.	10000
ProjectIdentifier	string	No	The ID of the file. You can call the ListFiles operation to query the ID of the file.	dw_project
FileId	long	Yes	The HTTP status code.	10000001

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The ID of the deployment task that deploys the file. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of this parameter is used to call the GetDeployment operation to poll the status of the asynchronous process. If this parameter is empty, the file is deleted and the polling is not required.	200
DeploymentId	long	The ID of the request. You can troubleshoot errors based on the ID.	1000000001
RequestId	string	The error message returned.	0000-ABCD-EFG****
ErrorMessage	string	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	The connection does not exist.
Success	boolean	The error code returned.	true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
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.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history