tencent cloud



Last updated: 2023-03-29 17:16:42

1. API Description

Domain name for API request: tcaplusdb.tencentcloudapi.com.

This API is used to delete a target IDL file by specifying the cluster ID and information of the file to be deleted. If the file is associated with a table, deletion will fail.

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: DeleteIdlFiles.
Version Yes String Common Params. The value used for this API: 2019-08-23.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String ID of the cluster where IDL resides
IdlFiles.N Yes Array of IdlFileInfo List of information of IDL files to be deleted

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of returned results
IdlFileInfos Array of IdlFileInfoWithoutContent Deletion result
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a target IDL file

This example shows you how to delete a target IDL file.

Input Example

Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIdlFiles
<Common request parameters>

    "ClusterId": "6084038577",
    "IdlFiles": [
            "FileExtType": "proto",
            "FileType": "PROTO",
            "FileName": "tb_example",
            "FileSize": 0,
            "FileContent": "xx",
            "FileId": 0

Output Example

    "Response": {
        "IdlFileInfos": [
                "Error": null,
                "FileExtType": "proto",
                "FileId": 849,
                "FileName": "tb_example",
                "FileSize": 266,
                "FileType": "PROTO"
        "RequestId": "4e79897b-5696-4d1b-b337-d2b46824de64",
        "TotalCount": 1

5. Developer Resources


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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support