tencent cloud

APIs

DocumentaçãoAPIsTencent Cloud DataBuddyDevelopment Studio APIsDeleteFile

DeleteFile

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-10-11 15:48:29

1. API Description

Domain name for API request: databuddy.intl.tencentcloudapi.com.

Move the file to Recycle Bin (soft deletion) and clear its version history and execution result snapshots.

Prerequisite

  1. The file corresponding to FileId must exist and be in active status;
  2. The caller has permission to delete the file;
  3. The file hasn't been referenced by a workflow task.

Error codes (Module are all Studio)

Error Code (Code) InnerCode Description Handling Suggestion
MissingParameter.WorkspaceId 1030001 lack of WorkspaceId Please input WorkspaceId
MissingParameter.FileId 1030003 lack of FileId Please import FileId
InvalidParameterValue.FileType 1030102 FileType value not supported FileType takes FILE/NOTEBOOK_FILE/SQL_FILE
ResourceNotFound.FileNotFound 1030203 File does not exist or has been deleted Please confirm the FileId
ResourceInUse.FileReferencedByTask 1030204 The file is referenced by a workflow task and cannot be deleted. Disassociate the task reference first.
UnauthorizedOperation.FileDeleteDenied 1030303 No deletion permission for this file Contact the file owner or space admin for authorization
InternalError 1030900 Internal service error Please carry the RequestId and contact support

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DeleteFile.
Version Yes String Common Params. The value used for this API: 2026-07-15.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
WorkspaceId Yes String

Workspace ID. Source: WorkspaceId returned by the ListWorkspaces API
FileId Yes String

File ID. Source: FileId returned by the CreateFile / ListFiles / GetFile APIs
FileType No String

File type. Parameter Value: FILE (regular file/script), NOTEBOOK_FILE (Notebook), SQL_FILE (SQL file). Corresponds to common/domain/entity.proto EntityType

3. Output Parameters

Parameter Name Type Description
Data DeleteFileResult

Returned results
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Delete a File

Input Example

POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteFile
<Common request parameters>

{
    "WorkspaceId": "17678671667189298",
    "FileId": "878246303882788864",
    "FileType": "NOTEBOOK_FILE"
}

Output Example

{
    "Response": {
        "Data": null,
        "RequestId": "69bfd283-9bc7-4a0b-a9e8-bbd07f369eea"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Anterior: UpdateFilePróximo: GetFile

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation