全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：DeleteFile - 删除数据开发中的文件

    文档中心

    大数据开发治理平台 DataWorks：DeleteFile - 删除数据开发中的文件

    更新时间：Nov 15, 2024

    调用DeleteFile删除数据开发中的文件。如果文件已经提交过，那么DeleteFile API会同时触发一个异步在调度系统删除的流程，需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dataworks:*delete
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    ProjectIdlong否

    DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。

    该参数与 ProjectIdentifier 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。

    		10000
    ProjectIdentifierstring否

    DataWorks 工作空间的名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。

    该参数与 ProjectId 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。

    		dw_project
    FileIdlong是

    文件的 ID，您可以使用 ListFiles 接口查询对应文件的 ID。

    		10000001

    返回参数

    名称类型描述示例值
    object

    返回结果。

    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    DeploymentIdlong

    如果文件已经提交过，那么 DeleteFile 接口会同时触发一个异步在调度系统删除的流程，需要用 DeleteFile 接口返回的 DeploymentId 继续调用 GetDeployment 轮询被触发的异步删除流程的状态。

    如果该字段为空，则说明文件已经删除完毕，无需继续轮询。

    		1000000001
    RequestIdstring

    请求 ID。用于出现错误后排查问题。

    		0000-ABCD-EFG****
    ErrorMessagestring

    错误信息。

    		The connection does not exist.
    Successboolean

    调用是否成功。取值如下：

    • true：调用成功。
    • false：调用失败。
    		true
    ErrorCodestring

    错误码。

    		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错误码错误信息描述
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史