调用DeleteFile删除数据开发中的文件。如果文件已经提交过,那么DeleteFile API会同时触发一个异步在调度系统删除的流程,需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteFile |
要执行的操作。 |
ProjectId | Long | 否 | 10000 |
DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。 该参数与ProjectIdentifier参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。 |
RegionId | String | 是 | cn-zhangjiakou |
地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。 |
ProjectIdentifier | String | 否 | dw_project |
DataWorks工作空间的名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。 该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。 |
FileId | Long | 是 | 10000001 |
文件的ID,您可以使用ListFiles接口查询对应文件的ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
DeploymentId | Long | 1000000001 |
如果文件已经提交过,那么DeleteFile接口会同时触发一个异步在调度系统删除的流程,需要用DeleteFile接口返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。 如果该字段为空,则说明文件已经删除完毕,无需继续轮询。 |
RequestId | String | 0000-ABCD-EFG**** |
请求ID。用于出现错误后排查问题。 |
ErrorMessage | String | The connection does not exist. |
错误信息。 |
Success | Boolean | true |
调用是否成功。取值如下:
|
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
错误码。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DeleteFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=10000001
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DeleteFileResponse>
<HttpStatusCode>200</HttpStatusCode>
<DeploymentId>1000000001</DeploymentId>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</DeleteFileResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"DeploymentId" : 1000000001,
"RequestId" : "0000-ABCD-EFG****",
"ErrorMessage" : "The connection does not exist.",
"Success" : true,
"ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
访问错误中心查看更多错误码。